ompl::base::GoalSampleableRegion Class Reference

Abstract definition of a goal region that can be sampled. More...

#include <GoalSampleableRegion.h>

Inheritance diagram for ompl::base::GoalSampleableRegion:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool canSample (void) const
 Return true of maxSampleCount() > 0, since in this case samples can certainly be produced.
 GoalSampleableRegion (const SpaceInformationPtr &si)
 Create a goal region that can be sampled.
virtual unsigned int maxSampleCount (void) const =0
 Return the maximum number of samples that can be asked for before repeating.
virtual void sampleGoal (State *st) const =0
 Sample a state in the goal region.
virtual ~GoalSampleableRegion (void)

Detailed Description

Abstract definition of a goal region that can be sampled.

Definition at line 49 of file GoalSampleableRegion.h.


Constructor & Destructor Documentation

ompl::base::GoalSampleableRegion::GoalSampleableRegion ( const SpaceInformationPtr si  )  [inline]

Create a goal region that can be sampled.

Definition at line 54 of file GoalSampleableRegion.h.

virtual ompl::base::GoalSampleableRegion::~GoalSampleableRegion ( void   )  [inline, virtual]

Definition at line 58 of file GoalSampleableRegion.h.


Member Function Documentation

virtual bool ompl::base::GoalSampleableRegion::canSample ( void   )  const [inline, virtual]

Return true of maxSampleCount() > 0, since in this case samples can certainly be produced.

Reimplemented in ompl::base::GoalLazySamples.

Definition at line 69 of file GoalSampleableRegion.h.

virtual unsigned int ompl::base::GoalSampleableRegion::maxSampleCount ( void   )  const [pure virtual]

Return the maximum number of samples that can be asked for before repeating.

Implemented in ompl::base::GoalState, and ompl::base::GoalStates.

virtual void ompl::base::GoalSampleableRegion::sampleGoal ( State st  )  const [pure virtual]

Sample a state in the goal region.

Implemented in ompl::base::GoalLazySamples, ompl::base::GoalState, and ompl::base::GoalStates.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


ompl
Author(s): Ioan Sucan/isucan@rice.edu, Mark Moll/mmoll@rice.edu, Lydia Kavraki/kavraki@rice.edu
autogenerated on Fri Jan 11 09:33:59 2013