stateObservation::IndexedMatrixT< MatrixType, lazy > Class Template Reference

This class describes a structure composed by a matrix of a given size and a time-index parameter. It can tell also if it is initialized or not. More...

#include <state-observation/tools/definitions.hpp>

Inheritance diagram for stateObservation::IndexedMatrixT< MatrixType, lazy >:

Collaboration diagram for stateObservation::IndexedMatrixT< MatrixType, lazy >:

Public Member Functions
	IndexedMatrixT ()
	Default constructor. More...
	IndexedMatrixT (const MatrixType &v, TimeIndex k)
	A constructor with a given matrix value and a time index. More...
IndexedMatrixT &	set (const MatrixType &v, TimeIndex k)
	Set the value of the matrix and the time sample. More...
void	set (bool value=true)
	Switch the vector to "initialized" state. More...
void	setIndex (TimeIndex index)
	set the index of the matrix More...
const MatrixType &	operator() () const
	Get the matrix value (const version) More...
MatrixType &	operator() ()
	Get the matrix value. More...
TimeIndex	getTime () const
	Get the time index. More...
bool	isSet () const
	Says whether the matrix is initialized or not. More...
void	reset ()
	Switch off the initalization flag, the value is no longer accessible. More...

Protected Member Functions
bool	check_ () const
Protected Member Functions inherited from stateObservation::DebugItem< bool, detail::defaultTrue, !false||isDebug >
	DebugItem ()
	DebugItem (const bool &v)
bool &	operator= (bool v)
	operator bool () const
bool	set (const bool &v)
bool	get () const

Protected Attributes
TimeIndex	k_
MatrixType	v_

Detailed Description

template<typename MatrixType = Matrix, bool lazy = false>
class stateObservation::IndexedMatrixT< MatrixType, lazy >

This class describes a structure composed by a matrix of a given size and a time-index parameter. It can tell also if it is initialized or not.

Constructor & Destructor Documentation

IndexedMatrixT() [1/2]

template<typename MatrixType = Matrix, bool lazy = false>

stateObservation::IndexedMatrixT< MatrixType, lazy >::IndexedMatrixT

(

)

Default constructor.

IndexedMatrixT() [2/2]

template<typename MatrixType = Matrix, bool lazy = false>

stateObservation::IndexedMatrixT< MatrixType, lazy >::IndexedMatrixT	(	const MatrixType &	v,
		TimeIndex	k
	)

A constructor with a given matrix value and a time index.

Member Function Documentation

check_()

template<typename MatrixType = Matrix, bool lazy = false>

bool stateObservation::IndexedMatrixT< MatrixType, lazy >::check_ ( ) const

inlineprotected

Checks whether the matrix is set or not (assert) does nothing in release mode

getTime()

template<typename MatrixType = Matrix, bool lazy = false>

TimeIndex stateObservation::IndexedMatrixT< MatrixType, lazy >::getTime ( ) const

inline

Get the time index.

isSet()

template<typename MatrixType = Matrix, bool lazy = false>

bool stateObservation::IndexedMatrixT< MatrixType, lazy >::isSet ( ) const

inline

Says whether the matrix is initialized or not.

operator()() [1/2]

template<typename MatrixType = Matrix, bool lazy = false>

MatrixType& stateObservation::IndexedMatrixT< MatrixType, lazy >::operator() ( )

inline

Get the matrix value.

operator()() [2/2]

template<typename MatrixType = Matrix, bool lazy = false>

const MatrixType& stateObservation::IndexedMatrixT< MatrixType, lazy >::operator() ( ) const

inline

Get the matrix value (const version)

reset()

template<typename MatrixType = Matrix, bool lazy = false>

void stateObservation::IndexedMatrixT< MatrixType, lazy >::reset ( )

inline

Switch off the initalization flag, the value is no longer accessible.

set() [1/2]

template<typename MatrixType = Matrix, bool lazy = false>

void stateObservation::IndexedMatrixT< MatrixType, lazy >::set ( bool  value = true )

inline

Switch the vector to "initialized" state.

set() [2/2]

template<typename MatrixType = Matrix, bool lazy = false>

IndexedMatrixT& stateObservation::IndexedMatrixT< MatrixType, lazy >::set ( const MatrixType &  v, TimeIndex  k  )

inline

Set the value of the matrix and the time sample.

setIndex()

template<typename MatrixType = Matrix, bool lazy = false>

void stateObservation::IndexedMatrixT< MatrixType, lazy >::setIndex ( TimeIndex  index )

inline

set the index of the matrix

Member Data Documentation

k_

template<typename MatrixType = Matrix, bool lazy = false>

TimeIndex stateObservation::IndexedMatrixT< MatrixType, lazy >::k_

protected

v_

template<typename MatrixType = Matrix, bool lazy = false>

MatrixType stateObservation::IndexedMatrixT< MatrixType, lazy >::v_

protected

---

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

• include/state-observation/tools/definitions.hpp