ompl::base::MorseTerminationCondition Class Reference

This class represents a termination condition for the planner that only terminates if the user shuts down the MORSE simulation. More...

#include <ompl/extensions/morse/MorseTerminationCondition.h>

Inheritance diagram for ompl::base::MorseTerminationCondition:

Public Member Functions

 MorseTerminationCondition (const MorseEnvironmentPtr env)
 
bool eval () const
 Return true if the simulation is still running.
 
- Public Member Functions inherited from ompl::base::PlannerTerminationCondition
 PlannerTerminationCondition (const PlannerTerminationConditionFn &fn)
 Construct a termination condition. By default, eval() will call the externally specified function fn to decide whether the planner should terminate.
 
 PlannerTerminationCondition (const PlannerTerminationConditionFn &fn, double period)
 Construct a termination condition that is evaluated every period seconds. The evaluation of the condition consists of calling fn() in a separate thread. Calls to eval() will always return the last value computed by the call to fn().
 
bool operator() () 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 () 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.
 
bool eval () const
 The implementation of some termination condition. By default, this just calls fn_()
 

Public Attributes

const MorseEnvironmentPtr env_
 The representation of the MORSE simulation environment.
 

Detailed Description

This class represents a termination condition for the planner that only terminates if the user shuts down the MORSE simulation.

Definition at line 49 of file MorseTerminationCondition.h.


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