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

enum ompl::base::PlannerStatus::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.
INFEASIBLE	The planner decided that problem is infeasible.
TYPE_COUNT	The number of possible status values.

Definition at line 51 of file PlannerStatus.h.

Constructor & Destructor Documentation

PlannerStatus() [1/2]

ompl::base::PlannerStatus::PlannerStatus ( StatusType status = UNKNOWN )

inline

Default constructor.

Definition at line 78 of file PlannerStatus.h.

PlannerStatus() [2/2]

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 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()

ompl::base::PlannerStatus::operator bool ( ) const

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()

ompl::base::PlannerStatus::operator StatusType ( ) const

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