ompl::base::PlannerStatus Struct Reference

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, 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.

Enumerator
UNKNOWN 

Uninitialized status.

INVALID_START 

Invalid start state or no start state specified.

INVALID_GOAL 

Invalid goal state.

UNRECOGNIZED_GOAL_TYPE 

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

TIMEOUT 

The planner failed to find a solution.

APPROXIMATE_SOLUTION 

The planner found an approximate solution.

EXACT_SOLUTION 

The planner found an exact solution.

CRASH 

The planner crashed.

ABORT 

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

TYPE_COUNT 

The number of possible status values.

Definition at line 51 of file PlannerStatus.h.

Constructor & Destructor Documentation

◆ PlannerStatus()

ompl::base::PlannerStatus::PlannerStatus ( bool  hasSolution,
bool  isApproximate 
)
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 82 of file PlannerStatus.h.


The documentation for this struct was generated from the following files: