ompl::base::UniformValidStateSampler Class Reference

A state sampler that only samples valid states, uniformly. More...

#include <UniformValidStateSampler.h>

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

List of all members.

Public Member Functions

virtual bool sample (State *state)
 Sample a state. Return false in case of failure.
virtual bool sampleNear (State *state, const State *near, const double distance)
 Sample a state near another, within specified distance. Return false, in case of failure.
 UniformValidStateSampler (const SpaceInformation *si)
 Constructor.
virtual ~UniformValidStateSampler (void)

Protected Attributes

StateSamplerPtr sampler_
 The sampler to build upon.

Detailed Description

A state sampler that only samples valid states, uniformly.

Definition at line 50 of file UniformValidStateSampler.h.


Constructor & Destructor Documentation

ompl::base::UniformValidStateSampler::UniformValidStateSampler ( const SpaceInformation si  ) 

Constructor.

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

Definition at line 57 of file UniformValidStateSampler.h.


Member Function Documentation

virtual bool ompl::base::UniformValidStateSampler::sample ( State state  )  [virtual]

Sample a state. Return false in case of failure.

Implements ompl::base::ValidStateSampler.

virtual bool ompl::base::UniformValidStateSampler::sampleNear ( State state,
const State near,
const double  distance 
) [virtual]

Sample a state near another, within specified distance. Return false, in case of failure.

Note:
The memory for near must be disjoint from the memory for state

Implements ompl::base::ValidStateSampler.


Member Data Documentation

The sampler to build upon.

Definition at line 67 of file UniformValidStateSampler.h.


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:34:01 2013