The MoveIt Motion Planning Framework for ROS 2.
Public Member Functions | Protected Attributes | List of all members
ompl_interface::GoalSampleableRegionMux Class Reference

#include <goal_union.h>

Inheritance diagram for ompl_interface::GoalSampleableRegionMux:
Inheritance graph
Collaboration diagram for ompl_interface::GoalSampleableRegionMux:
Collaboration graph

Public Member Functions

 GoalSampleableRegionMux (const std::vector< ompl::base::GoalPtr > &goals)
 Constructor. More...
 ~GoalSampleableRegionMux () override
void sampleGoal (ompl::base::State *st) const override
 Sample a goal. More...
unsigned int maxSampleCount () const override
 Get the max sample count. More...
virtual bool canSample () const
 Query if sampler can find any sample. More...
bool couldSample () const override
 Query if sampler could find a sample in the future. More...
bool isSatisfied (const ompl::base::State *st, double *distance) const override
 Is the goal satisfied for this state (given a distance) More...
double distanceGoal (const ompl::base::State *st) const override
 Find the distance of this state from the goal. More...
void startSampling ()
 If there are any member lazy samplers, start them. More...
void stopSampling ()
 If there are any member lazy samplers, stop them. More...
void print (std::ostream &out=std::cout) const override
 Pretty print goal information. More...

Protected Attributes

std::vector< ompl::base::GoalPtr > goals_
unsigned int gindex_

Detailed Description

Definition at line 42 of file goal_union.h.

Constructor & Destructor Documentation

◆ GoalSampleableRegionMux()

ompl_interface::GoalSampleableRegionMux::GoalSampleableRegionMux ( const std::vector< ompl::base::GoalPtr > &  goals)


goalsThe input set of goals

Definition at line 60 of file goal_union.cpp.

◆ ~GoalSampleableRegionMux()

ompl_interface::GoalSampleableRegionMux::~GoalSampleableRegionMux ( )

Definition at line 49 of file goal_union.h.

Member Function Documentation

◆ canSample()

bool ompl_interface::GoalSampleableRegionMux::canSample ( ) const

Query if sampler can find any sample.

Definition at line 105 of file goal_union.cpp.

◆ couldSample()

bool ompl_interface::GoalSampleableRegionMux::couldSample ( ) const

Query if sampler could find a sample in the future.

Definition at line 115 of file goal_union.cpp.

◆ distanceGoal()

double ompl_interface::GoalSampleableRegionMux::distanceGoal ( const ompl::base::State *  st) const

Find the distance of this state from the goal.

Definition at line 135 of file goal_union.cpp.

◆ isSatisfied()

bool ompl_interface::GoalSampleableRegionMux::isSatisfied ( const ompl::base::State *  st,
double *  distance 
) const

Is the goal satisfied for this state (given a distance)

Definition at line 125 of file goal_union.cpp.

Here is the call graph for this function:

◆ maxSampleCount()

unsigned int ompl_interface::GoalSampleableRegionMux::maxSampleCount ( ) const

Get the max sample count.

Definition at line 97 of file goal_union.cpp.

◆ print()

void ompl_interface::GoalSampleableRegionMux::print ( std::ostream &  out = std::cout) const

Pretty print goal information.

Definition at line 147 of file goal_union.cpp.

◆ sampleGoal()

void ompl_interface::GoalSampleableRegionMux::sampleGoal ( ompl::base::State *  st) const

Sample a goal.

Definition at line 83 of file goal_union.cpp.

◆ startSampling()

void ompl_interface::GoalSampleableRegionMux::startSampling ( )

If there are any member lazy samplers, start them.

Definition at line 65 of file goal_union.cpp.

◆ stopSampling()

void ompl_interface::GoalSampleableRegionMux::stopSampling ( )

If there are any member lazy samplers, stop them.

Definition at line 74 of file goal_union.cpp.

Member Data Documentation

◆ gindex_

unsigned int ompl_interface::GoalSampleableRegionMux::gindex_

Definition at line 82 of file goal_union.h.

◆ goals_

std::vector<ompl::base::GoalPtr> ompl_interface::GoalSampleableRegionMux::goals_

Definition at line 81 of file goal_union.h.

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