A class to store the exit status of Planner::solve() More...
#include <ompl/base/PlannerStatus.h>
Public Types | |
enum | StatusType { UNKNOWN = 0 , INVALID_START , INVALID_GOAL , UNRECOGNIZED_GOAL_TYPE , TIMEOUT , APPROXIMATE_SOLUTION , EXACT_SOLUTION , CRASH , ABORT , INFEASIBLE , TYPE_COUNT } |
The possible values of the status returned by a planner. More... | |
Public Member Functions | |
PlannerStatus (StatusType status=UNKNOWN) | |
Default constructor. | |
PlannerStatus (bool hasSolution, bool isApproximate) | |
std::string | asString () const |
Return a string representation. | |
operator bool () const | |
Allow casting to true. The value is true iff an approximate or exact solution was found. | |
operator StatusType () const | |
Allow casting to the enum type StatusType. | |
Detailed Description
A class to store the exit status of Planner::solve()
Definition at line 48 of file PlannerStatus.h.
Member Enumeration Documentation
◆ StatusType
The possible values of the status returned by a planner.
Definition at line 51 of file PlannerStatus.h.
Constructor & Destructor Documentation
◆ PlannerStatus() [1/2]
|
inline |
Default constructor.
Definition at line 78 of file PlannerStatus.h.
◆ PlannerStatus() [2/2]
|
inline |
Convenience constructor that sets status_ based on whether some solution was found (hasSolution) and whether that solution was approximate or not (isApproximate)
Definition at line 84 of file PlannerStatus.h.
Member Function Documentation
◆ asString()
std::string ompl::base::PlannerStatus::asString | ( | ) | const |
Return a string representation.
Definition at line 39 of file PlannerStatus.cpp.
◆ operator bool()
|
inline |
Allow casting to true. The value is true iff an approximate or exact solution was found.
Definition at line 92 of file PlannerStatus.h.
◆ operator StatusType()
|
inline |
Allow casting to the enum type StatusType.
Definition at line 97 of file PlannerStatus.h.
The documentation for this struct was generated from the following files:
- ompl/base/PlannerStatus.h
- ompl/base/src/PlannerStatus.cpp