ompl::base::StateSamplerArray< T > Class Template Reference

Class to ease the creation of a set of samplers. This is especially useful for multi-threaded planners. More...

#include <StateSamplerArray.h>

List of all members.

Public Types
typedef SamplerSelector< T > ::Sampler	Sampler
	The type of sampler allocated.
typedef SamplerSelector< T > ::SamplerPtr	SamplerPtr
	Pointer to the type of sampler allocated.
Public Member Functions
void	clear (void)
	Clear all allocated samplers.
Sampler *	operator[] (std::size_t index) const
	Access operator for a specific sampler. For performance reasons, the bounds are not checked.
void	resize (std::size_t count)
	Create or release some state samplers.
std::size_t	size (void) const
	Get the count of samplers currently available.
	StateSamplerArray (const SpaceInformation *si)
	Constructor.
	StateSamplerArray (const SpaceInformationPtr &si)
	Constructor.
	~StateSamplerArray (void)
Private Attributes
std::vector< SamplerPtr >	samplers_
const SpaceInformation *	si_
SamplerSelector< T >	ss_

---

Detailed Description

template<typename T>
class ompl::base::StateSamplerArray< T >

Class to ease the creation of a set of samplers. This is especially useful for multi-threaded planners.

Definition at line 88 of file StateSamplerArray.h.

---

Member Typedef Documentation

template<typename T>

typedef SamplerSelector<T>::Sampler ompl::base::StateSamplerArray< T >::Sampler

The type of sampler allocated.

Definition at line 96 of file StateSamplerArray.h.

template<typename T>

typedef SamplerSelector<T>::SamplerPtr ompl::base::StateSamplerArray< T >::SamplerPtr

Pointer to the type of sampler allocated.

Definition at line 93 of file StateSamplerArray.h.

---

Constructor & Destructor Documentation

template<typename T>

ompl::base::StateSamplerArray< T >::StateSamplerArray

(

const SpaceInformationPtr &

si

)

[inline]

Constructor.

Definition at line 99 of file StateSamplerArray.h.

template<typename T>

ompl::base::StateSamplerArray< T >::StateSamplerArray

(

const SpaceInformation *

si

)

[inline]

Constructor.

Definition at line 104 of file StateSamplerArray.h.

template<typename T>

ompl::base::StateSamplerArray< T >::~StateSamplerArray

(

void

)

[inline]

Definition at line 108 of file StateSamplerArray.h.

---

Member Function Documentation

template<typename T>

void ompl::base::StateSamplerArray< T >::clear

(

void

)

[inline]

Clear all allocated samplers.

Definition at line 141 of file StateSamplerArray.h.

template<typename T>

Sampler* ompl::base::StateSamplerArray< T >::operator[]

(

std::size_t

index

)

const [inline]

Access operator for a specific sampler. For performance reasons, the bounds are not checked.

Definition at line 114 of file StateSamplerArray.h.

template<typename T>

void ompl::base::StateSamplerArray< T >::resize

(

std::size_t

count

)

[inline]

Create or release some state samplers.

Definition at line 120 of file StateSamplerArray.h.

template<typename T>

std::size_t ompl::base::StateSamplerArray< T >::size

(

void

)

const [inline]

Get the count of samplers currently available.

Definition at line 135 of file StateSamplerArray.h.

---

Member Data Documentation

template<typename T>

std::vector<SamplerPtr> ompl::base::StateSamplerArray< T >::samplers_ [private]

Definition at line 150 of file StateSamplerArray.h.

template<typename T>

const SpaceInformation* ompl::base::StateSamplerArray< T >::si_ [private]

Definition at line 148 of file StateSamplerArray.h.

template<typename T>

SamplerSelector<T> ompl::base::StateSamplerArray< T >::ss_ [private]

Definition at line 149 of file StateSamplerArray.h.

---

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

• StateSamplerArray.h