pathfindingErrors.h

Go to the documentation of this file.

 
#ifndef Q_HEX_WALKER_PATHFINDING_ERRORS_H
#define Q_HEX_WALKER_PATHFINDING_ERRORS_H
 
#include <stdexcept>
#include <string>
 
enum class PathfindingError {
    None = 0,          
    InvalidCell,       
    SameStartEnd,      
    BlockedStartCell,  
    BlockedEndCell,    
    NoPathFound,       
    ConversionError,   
    CoordinateError,   
    MaxIterations,     
    InternalError      
};
 
inline std::string pathfindingErrorToString(const PathfindingError error) {
    switch (error) {
    case PathfindingError::None:
        return "No error";
    case PathfindingError::InvalidCell:
        return "Invalid H3 cell index";
    case PathfindingError::SameStartEnd:
        return "Start and end points are identical";
    case PathfindingError::BlockedStartCell:
        return "Start cell is blocked";
    case PathfindingError::BlockedEndCell:
        return "End cell is blocked";
    case PathfindingError::NoPathFound:
        return "No path found between points";
    case PathfindingError::ConversionError:
        return "Error converting between H3 resolutions";
    case PathfindingError::CoordinateError:
        return "Error getting cell coordinates";
    case PathfindingError::MaxIterations:
        return "Search exceeded maximum iterations";
    case PathfindingError::InternalError:
        return "Internal algorithm error";
    default:
        return "Unknown error";
    }
}
 
class PathfindingException final : public std::runtime_error {
public:
    explicit PathfindingException(const PathfindingError error)
        : std::runtime_error(pathfindingErrorToString(error)), errorCode_(error) {}
 
    [[nodiscard("known error")]] PathfindingError errorCode() const noexcept { return errorCode_; }
 
private:
    PathfindingError errorCode_;
};
 
#endif  // Q_HEX_WALKER_PATHFINDING_ERRORS_H