Aikido
aikido::constraint::uniform::RConstantSampler< N > Class Template Reference

ConstantSampler for RealVectorStates. More...

#include <aikido/constraint/uniform/RnConstantSampler.hpp>

Inheritance diagram for aikido::constraint::uniform::RConstantSampler< N >:
aikido::constraint::Sampleable

Public Types

using VectorNd = Eigen::Matrix< double, N, 1 >
 

Public Member Functions

 RConstantSampler (std::shared_ptr< const statespace::R< N >> _space, const VectorNd &_value)
 Constructor. More...
 
statespace::ConstStateSpacePtr getStateSpace () const override
 Gets the StateSpace that this constraint operates on. More...
 
std::unique_ptr< constraint::SampleGeneratorcreateSampleGenerator () const override
 Creates a SampleGenerator for sampling from this constraint. More...
 
const VectorNdgetConstantValue () const
 Returns constant value to be generated by this sampler. More...
 
- Public Member Functions inherited from aikido::constraint::Sampleable
virtual ~Sampleable ()=default
 

Private Attributes

std::shared_ptr< const statespace::R< N > > mSpace
 
VectorNd mValue
 

Detailed Description

template<int N>
class aikido::constraint::uniform::RConstantSampler< N >

ConstantSampler for RealVectorStates.

Stub sampler for WeldJoint or any fixed constant state space.

Member Typedef Documentation

◆ VectorNd

template<int N>
using aikido::constraint::uniform::RConstantSampler< N >::VectorNd = Eigen::Matrix<double, N, 1>

Constructor & Destructor Documentation

◆ RConstantSampler()

template<int N>
aikido::constraint::uniform::RConstantSampler< N >::RConstantSampler ( std::shared_ptr< const statespace::R< N >>  _space,
const VectorNd _value 
)

Constructor.

Parameters
_spaceSpace in which this constraint operates.
_valueValue to return when sampled.

Member Function Documentation

◆ createSampleGenerator()

template<int N>
std::unique_ptr< constraint::SampleGenerator > aikido::constraint::uniform::RConstantSampler< N >::createSampleGenerator ( ) const
overridevirtual

Creates a SampleGenerator for sampling from this constraint.

Implements aikido::constraint::Sampleable.

◆ getConstantValue()

template<int N>
const RConstantSampler< N >::VectorNd & aikido::constraint::uniform::RConstantSampler< N >::getConstantValue

Returns constant value to be generated by this sampler.

◆ getStateSpace()

template<int N>
statespace::ConstStateSpacePtr aikido::constraint::uniform::RConstantSampler< N >::getStateSpace ( ) const
overridevirtual

Gets the StateSpace that this constraint operates on.

Implements aikido::constraint::Sampleable.

Member Data Documentation

◆ mSpace

template<int N>
std::shared_ptr<const statespace::R<N> > aikido::constraint::uniform::RConstantSampler< N >::mSpace
private

◆ mValue

template<int N>
VectorNd aikido::constraint::uniform::RConstantSampler< N >::mValue
private