Loading...
Searching...
No Matches
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 <ompl/base/StateSamplerArray.h>

Public Types

using SamplerPtr = typename SamplerSelector< T >::SamplerPtr
 Pointer to the type of sampler allocated.
 
using Sampler = typename SamplerSelector< T >::Sampler
 The type of sampler allocated.
 

Public Member Functions

 StateSamplerArray (const SpaceInformationPtr &si)
 Constructor.
 
 StateSamplerArray (const SpaceInformation *si)
 Constructor.
 
Sampleroperator[] (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 () const
 Get the count of samplers currently available.
 
void clear ()
 Clear all allocated samplers.
 

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 87 of file StateSamplerArray.h.

Member Typedef Documentation

◆ Sampler

template<typename T >
using ompl::base::StateSamplerArray< T >::Sampler = typename SamplerSelector<T>::Sampler

The type of sampler allocated.

Definition at line 94 of file StateSamplerArray.h.

◆ SamplerPtr

template<typename T >
using ompl::base::StateSamplerArray< T >::SamplerPtr = typename SamplerSelector<T>::SamplerPtr

Pointer to the type of sampler allocated.

Definition at line 91 of file StateSamplerArray.h.

Constructor & Destructor Documentation

◆ StateSamplerArray() [1/2]

template<typename T >
ompl::base::StateSamplerArray< T >::StateSamplerArray ( const SpaceInformationPtr si)
inline

Constructor.

Definition at line 97 of file StateSamplerArray.h.

◆ StateSamplerArray() [2/2]

template<typename T >
ompl::base::StateSamplerArray< T >::StateSamplerArray ( const SpaceInformation si)
inline

Constructor.

Definition at line 102 of file StateSamplerArray.h.

Member Function Documentation

◆ clear()

template<typename T >
void ompl::base::StateSamplerArray< T >::clear ( )
inline

Clear all allocated samplers.

Definition at line 135 of file StateSamplerArray.h.

◆ operator[]()

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 110 of file StateSamplerArray.h.

◆ resize()

template<typename T >
void ompl::base::StateSamplerArray< T >::resize ( std::size_t  count)
inline

Create or release some state samplers.

Definition at line 116 of file StateSamplerArray.h.

◆ size()

template<typename T >
std::size_t ompl::base::StateSamplerArray< T >::size ( ) const
inline

Get the count of samplers currently available.

Definition at line 129 of file StateSamplerArray.h.


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