StateSampler Class Reference

interface for generating states. More...

#include <StateSampler.hpp>

Inherited by CollisionFreeSampler, FiniteStateSampler, PreshapeSampler, and SpherePoseSampler.

Public Types
typedef rw::core::Ptr< StateSampler >	Ptr

Public Member Functions
virtual bool	sample (rw::kinematics::State &state)=0
	Sample a state. More...
virtual bool	empty () const =0
	True if the sampler is known to contain no more configurations.

Detailed Description

interface for generating states.

Member Function Documentation

sample()

virtual bool sample ( rw::kinematics::State &  state )

pure virtual

Sample a state.

If sampling fails, the sampler may return the empty configuration. If empty() is true then the sampler has no more configurations. Otherwise sample() may (or may not) succeed if called a second time.

Implemented in SpherePoseSampler, PreshapeSampler, FiniteStateSampler, and CollisionFreeSampler.

---

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

• StateSampler.hpp