aikido
Public Types | Public Member Functions | Static Public Attributes | List of all members
aikido::statespace::RStateHandle< _QualifiedState > Class Template Reference

StateHandle for a Rn. More...

#include <Rn-impl.hpp>

Inheritance diagram for aikido::statespace::RStateHandle< _QualifiedState >:

Public Types

using VectorNd = typename R< DimensionAtCompileTime >::VectorNd
 
using ValueType = std::conditional< std::is_const< QualifiedState >::value, const VectorNd, VectorNd >
 

Public Member Functions

 RStateHandle ()
 Construct and initialize to nullptr.
 
 RStateHandle (const StateSpace *_space, QualifiedState *_state)
 Construct a handle for _state in _space. More...
 
Eigen::Map< const VectorNd > getValue ()
 Gets the real vector stored in this state. More...
 
void setValue (const VectorNd &_value)
 Sets the real vector stored in this state. More...
 

Static Public Attributes

static constexpr int DimensionAtCompileTime = _QualifiedState::DimensionAtCompileTime
 

Detailed Description

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

StateHandle for a Rn.

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

Template Parameters
_QualifiedStatetype of State being wrapped

Constructor & Destructor Documentation

§ RStateHandle()

template<class _QualifiedState >
aikido::statespace::RStateHandle< _QualifiedState >::RStateHandle ( const StateSpace _space,
QualifiedState *  _state 
)
inline

Construct a handle for _state in _space.

Parameters
_spacestate space that created _state
_statestate created by _space

Member Function Documentation

§ getValue()

template<class _QualifiedState >
Eigen::Map<const VectorNd> aikido::statespace::RStateHandle< _QualifiedState >::getValue ( )
inline

Gets the real vector stored in this state.

Returns
real vector stored in this state

§ setValue()

template<class _QualifiedState >
void aikido::statespace::RStateHandle< _QualifiedState >::setValue ( const VectorNd &  _value)
inline

Sets the real vector stored in this state.

Parameters
_valuereal vector to store in _state

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