ompl::base::StateSampler Class Reference

Abstract definition of a state space sampler. More...

#include <StateSampler.h>

Inheritance diagram for ompl::base::StateSampler:

[legend]

List of all members.

Public Member Functions
virtual void	sampleGaussian (State *state, const State *mean, const double stdDev)=0
	Sample a state using a Gaussian distribution with given mean and standard deviation (stdDev).
virtual void	sampleUniform (State *state)=0
	Sample a state.
virtual void	sampleUniformNear (State *state, const State *near, const double distance)=0
	Sample a state near another, within specified distance.
	StateSampler (const StateSpace *space)
	Constructor.
virtual	~StateSampler (void)
Protected Attributes
RNG	rng_
	An instance of a random number generator.
const StateSpace *	space_
	The state space this sampler samples.

---

Detailed Description

Abstract definition of a state space sampler.

Definition at line 60 of file StateSampler.h.

---

Constructor & Destructor Documentation

ompl::base::StateSampler::StateSampler

(

const StateSpace *

space

)

[inline]

Constructor.

Definition at line 65 of file StateSampler.h.

virtual ompl::base::StateSampler::~StateSampler

(

void

)

[inline, virtual]

Definition at line 69 of file StateSampler.h.

---

Member Function Documentation

virtual void ompl::base::StateSampler::sampleGaussian	(	State *	state,
		const State *	mean,
		const double	stdDev
	)			[pure virtual]

Sample a state using a Gaussian distribution with given mean and standard deviation (stdDev).

Implemented in ompl::base::RealVectorStateSampler, ompl::base::SO2StateSampler, ompl::base::SO3StateSampler, ompl::base::TimeStateSampler, and ompl::base::CompoundStateSampler.

virtual void ompl::base::StateSampler::sampleUniform

(

State *

state

)

[pure virtual]

Sample a state.

Implemented in ompl::base::RealVectorStateSampler, ompl::base::SO2StateSampler, ompl::base::SO3StateSampler, ompl::base::TimeStateSampler, and ompl::base::CompoundStateSampler.

virtual void ompl::base::StateSampler::sampleUniformNear	(	State *	state,
		const State *	near,
		const double	distance
	)			[pure virtual]

Sample a state near another, within specified distance.

Implemented in ompl::base::RealVectorStateSampler, ompl::base::SO2StateSampler, ompl::base::SO3StateSampler, ompl::base::TimeStateSampler, and ompl::base::CompoundStateSampler.

---

Member Data Documentation

RNG ompl::base::StateSampler::rng_ [protected]

An instance of a random number generator.

Definition at line 88 of file StateSampler.h.

const StateSpace* ompl::base::StateSampler::space_ [protected]

The state space this sampler samples.

Definition at line 85 of file StateSampler.h.

---

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

• StateSampler.h