All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
ompl::base::PlannerAlwaysTerminatingCondition Class Reference

Simple termination condition that always returns true. The termination condition will always be met. More...

#include <PlannerTerminationCondition.h>

Inheritance diagram for ompl::base::PlannerAlwaysTerminatingCondition:

Additional Inherited Members

- Public Member Functions inherited from ompl::base::PlannerTerminationCondition
 PlannerTerminationCondition (const PlannerTerminationConditionFn &fn=PlannerTerminationConditionFn())
 Construct a termination condition. By default, eval() will call the externally specified function fn to decide whether the planner should terminate. The function fn does not always need to be specified, if a different implementation of eval() is provided by a derived class.
 
bool operator() (void) const
 Return true if the planner should stop its computation.
 
 operator bool () const
 Cast as true if the planner should stop its computation.
 
void terminate (void) const
 Notify that the condition for termination should become true, regardless of what eval() returns. This function may be called while the condition is being evaluated by other threads.
 
virtual bool eval (void) const
 The implementation of some termination condition. By default, this just calls fn_()
 
- Protected Attributes inherited from ompl::base::PlannerTerminationCondition
PlannerTerminationConditionFn fn_
 Function pointer to the piece of code that decides whether a termination condition has been met.
 
bool terminate_
 Flag indicating whether the user has externally requested that the condition for termination should become true.
 

Detailed Description

Simple termination condition that always returns true. The termination condition will always be met.

Definition at line 164 of file PlannerTerminationCondition.h.


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