aikido::constraint::SequentialSampleable Class Reference

Sampleable that wraps a sequence of Sampleables. More...

#include <aikido/constraint/SequentialSampleable.hpp>

Inheritance diagram for aikido::constraint::SequentialSampleable:

Public Member Functions
	SequentialSampleable (statespace::StateSpacePtr stateSpace, const std::vector< ConstSampleablePtr > &sampleables)
	Constructor. More...
statespace::ConstStateSpacePtr	getStateSpace () const override
	Gets the StateSpace that this constraint operates on. More...
std::unique_ptr< SampleGenerator >	createSampleGenerator () const override
	Creates a SampleGenerator for sampling from this constraint. More...
Public Member Functions inherited from aikido::constraint::Sampleable
virtual	~Sampleable ()=default

Private Attributes
statespace::ConstStateSpacePtr	mStateSpace
	StateSpace in which the constraint operates. More...
const std::vector< ConstSampleablePtr >	mSampleables
	Sequence of sampleables. More...

Detailed Description

Sampleable that wraps a sequence of Sampleables.

Exhausts the current Sampleable before sampling from the next Sampleable in the sequence.

Constructor & Destructor Documentation

SequentialSampleable()

aikido::constraint::SequentialSampleable::SequentialSampleable	(	statespace::StateSpacePtr	stateSpace,
		const std::vector< ConstSampleablePtr > &	sampleables
	)

Constructor.

Parameters

[in]	stateSpace	StateSpace in which this constraint operates.
[in]	sampleables	Sequence of sampleables.

Member Function Documentation

createSampleGenerator()

std::unique_ptr<SampleGenerator> aikido::constraint::SequentialSampleable::createSampleGenerator ( ) const

overridevirtual

Creates a SampleGenerator for sampling from this constraint.

Implements aikido::constraint::Sampleable.

getStateSpace()

statespace::ConstStateSpacePtr aikido::constraint::SequentialSampleable::getStateSpace ( ) const

overridevirtual

Gets the StateSpace that this constraint operates on.

Implements aikido::constraint::Sampleable.

Member Data Documentation

mSampleables

const std::vector<ConstSampleablePtr> aikido::constraint::SequentialSampleable::mSampleables

private

Sequence of sampleables.

mStateSpace

statespace::ConstStateSpacePtr aikido::constraint::SequentialSampleable::mStateSpace

private

StateSpace in which the constraint operates.