Struct PlannerStatus

Struct Documentation

struct PlannerStatus

A class to store the exit status of Planner::solve()

Public Types

enum StatusType

The possible values of the status returned by a planner.

Values:

enumerator UNKNOWN

Uninitialized status.

enumerator INVALID_START

Invalid start state or no start state specified.

enumerator INVALID_GOAL

Invalid goal state.

enumerator UNRECOGNIZED_GOAL_TYPE

The goal is of a type that a planner does not recognize.

enumerator TIMEOUT

The planner failed to find a solution.

enumerator APPROXIMATE_SOLUTION

The planner found an approximate solution.

enumerator EXACT_SOLUTION

The planner found an exact solution.

enumerator CRASH

The planner crashed.

enumerator ABORT

The planner did not find a solution for some other reason.

enumerator INFEASIBLE

The planner decided that problem is infeasible.

enumerator TYPE_COUNT

The number of possible status values.

Public Functions

inline PlannerStatus(StatusType status = UNKNOWN)

Default constructor.

inline PlannerStatus(bool hasSolution, bool isApproximate)

Convenience constructor that sets status_ based on whether some solution was found (hasSolution) and whether that solution was approximate or not (isApproximate)

std::string asString() const

Return a string representation.

inline operator bool() const

Allow casting to true. The value is true iff an approximate or exact solution was found.

inline operator StatusType() const

Allow casting to the enum type StatusType.