state-observation 1.7.0
General implementation of observers.
Loading...
Searching...
No Matches
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 <definitions.hpp>

Inheritance diagram for stateObservation::IndexedMatrixT< MatrixType, lazy >:
[legend]
Collaboration diagram for stateObservation::IndexedMatrixT< MatrixType, lazy >:
[legend]

Public Member Functions

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

Protected Member Functions

bool check_ () const
Protected Member Functions inherited from stateObservation::DebugItem< bool, detail::defaultTrue, !false||isDebug >
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.

Definition at line 469 of file definitions.hpp.

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

Member Data Documentation

◆ k_

template<typename MatrixType = Matrix, bool lazy = false>
TimeIndex stateObservation::IndexedMatrixT< MatrixType, lazy >::k_
protected

Definition at line 510 of file definitions.hpp.

◆ v_

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

Definition at line 511 of file definitions.hpp.


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