aikido::statespace::CompoundStateHandle< _QualifiedState > Class Template Reference

StateHandle for a CartesianProduct. More...

#include <aikido/statespace/CartesianProduct.hpp>

Public Member Functions
	CompoundStateHandle ()
	Construct and initialize to nullptr. More...
	CompoundStateHandle (const StateSpace *_space, State *_state)
	Construct a handle for _state in _space. More...
template<class Space = statespace::StateSpace>
Space::State *	getSubState (std::size_t _index)
	Gets state by subspace index. More...
template<class Space = statespace::StateSpace>
const Space::State *	getSubState (std::size_t _index) const
	Gets state by subspace index. More...
template<class Space = statespace::StateSpace>
Space::StateHandle	getSubStateHandle (std::size_t _index)
	Gets state by subspace index and wraps it in a Space::StateHandle helper class. More...
template<class Space = statespace::StateSpace>
Space::StateHandleConst	getSubStateHandle (std::size_t _index) const
	Gets state by subspace index and wraps it in a Space::StateHandle helper class. More...

Detailed Description

template<class _QualifiedState>
class aikido::statespace::CompoundStateHandle< _QualifiedState >

StateHandle for a CartesianProduct.

The template parameter is necessary to support both const and non-const states.

Constructor & Destructor Documentation

CompoundStateHandle() [1/2]

template<class _QualifiedState >

aikido::statespace::CompoundStateHandle< _QualifiedState >::CompoundStateHandle ( )

inline

Construct and initialize to nullptr.

CompoundStateHandle() [2/2]

template<class _QualifiedState >

aikido::statespace::CompoundStateHandle< _QualifiedState >::CompoundStateHandle ( const StateSpace *  _space, State *  _state  )

inline

Construct a handle for _state in _space.

Parameters

_space	state space that created _state
_state	state created by _space

Member Function Documentation

getSubState() [1/2]

template<class _QualifiedState >

template<class Space = statespace::StateSpace>

Space::State* aikido::statespace::CompoundStateHandle< _QualifiedState >::getSubState ( std::size_t  _index )

inline

Gets state by subspace index.

Template Parameters

Space

type of StateSpace for subspace _index

Parameters

_index

in the range [ 0, getNumSubspaces() ]

Returns

state at _index

getSubState() [2/2]

template<class _QualifiedState >

template<class Space = statespace::StateSpace>

const Space::State* aikido::statespace::CompoundStateHandle< _QualifiedState >::getSubState ( std::size_t  _index ) const

inline

Gets state by subspace index.

Template Parameters

Space

type of StateSpace for subspace _index

Parameters

_index

in the range [ 0, getNumSubspaces() ]

Returns

state at _index

getSubStateHandle() [1/2]

template<class _QualifiedState >

template<class Space = statespace::StateSpace>

Space::StateHandle aikido::statespace::CompoundStateHandle< _QualifiedState >::getSubStateHandle ( std::size_t  _index )

inline

Gets state by subspace index and wraps it in a Space::StateHandle helper class.

Template Parameters

Space

type of StateSpace for subspace _index

Parameters

_index

in the range [ 0, getNumSubspaces() ]

Returns

state at _index

getSubStateHandle() [2/2]

template<class _QualifiedState >

template<class Space = statespace::StateSpace>

Space::StateHandleConst aikido::statespace::CompoundStateHandle< _QualifiedState >::getSubStateHandle ( std::size_t  _index ) const

inline

Gets state by subspace index and wraps it in a Space::StateHandle helper class.

Template Parameters

Space

type of StateSpace for subspace _index

Parameters

_index

in the range [ 0, getNumSubspaces() ]

Returns

state at _index