Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
ompl::base::WrapperStateSampler Class Reference

A state sampler that wraps around another state sampler. More...

#include <ompl/base/spaces/WrapperStateSpace.h>

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

Public Member Functions

 WrapperStateSampler (const StateSpace *space, StateSamplerPtr sampler)
 Constructor. Requires the wrapper state space space and the underlying sampler sampler.
void sampleUniform (State *state) override
 Sample a state using underlying sampler.
void sampleUniformNear (State *state, const State *near, double distance) override
 Sample a nearby state using underlying sampler.
void sampleGaussian (State *state, const State *mean, double stdDev) override
 Sample a state within a Gaussian distribution using underlying sampler.
Public Member Functions inherited from ompl::base::StateSampler
 StateSampler (const StateSampler &)=delete
StateSampler & operator= (const StateSampler &)=delete
 StateSampler (const StateSpace *space)
 Constructor.

Protected Attributes

StateSamplerPtr sampler_
 Underlying state sampler.
Protected Attributes inherited from ompl::base::StateSampler
const StateSpace * space_
 The state space this sampler samples.
RNG rng_
 An instance of a random number generator.

Detailed Description

A state sampler that wraps around another state sampler.

Definition at line 54 of file WrapperStateSpace.h.

Constructor & Destructor Documentation

◆ WrapperStateSampler()

ompl::base::WrapperStateSampler::WrapperStateSampler ( const StateSpace * space,
StateSamplerPtr sampler )
inline

Constructor. Requires the wrapper state space space and the underlying sampler sampler.

Definition at line 59 of file WrapperStateSpace.h.

Member Function Documentation

◆ sampleGaussian()

void ompl::base::WrapperStateSampler::sampleGaussian ( State * state,
const State * mean,
double stdDev )
overridevirtual

Sample a state within a Gaussian distribution using underlying sampler.

Implements ompl::base::StateSampler.

Definition at line 50 of file WrapperStateSpace.cpp.

◆ sampleUniform()

void ompl::base::WrapperStateSampler::sampleUniform ( State * state)
overridevirtual

Sample a state using underlying sampler.

Implements ompl::base::StateSampler.

Definition at line 39 of file WrapperStateSpace.cpp.

◆ sampleUniformNear()

void ompl::base::WrapperStateSampler::sampleUniformNear ( State * state,
const State * near,
double distance )
overridevirtual

Sample a nearby state using underlying sampler.

Implements ompl::base::StateSampler.

Definition at line 44 of file WrapperStateSpace.cpp.

Member Data Documentation

◆ sampler_

StateSamplerPtr ompl::base::WrapperStateSampler::sampler_
protected

Underlying state sampler.

Definition at line 75 of file WrapperStateSpace.h.

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