tuw::StateMapping< InputStateType, OutputStateType, ParamType > Class Template Reference

Interface for a filter that performs a (nonlinear) mapping from the input state to an output state. More...

#include <state_mapping.hpp>

Public Member Functions
virtual std::shared_ptr< OutputStateType > &	compute (std::shared_ptr< InputStateType > &_x, const double &_t)=0
	Computes the output state after a (nonlinear) state mapping. More...
StateMapping &	operator= (const StateMapping &)=default
StateMapping &	operator= (StateMapping &&)=default
std::shared_ptr< OutputStateType > &	output ()
	Access to the last computed output state. More...
virtual void	reloadParam ()=0
	Reloads class parameters. To be called when parameters that influence the class variables are changed. More...
	StateMapping (std::shared_ptr< ParamType > &_params)
	StateMapping (const StateMapping &)=default
	StateMapping (StateMapping &&)=default
virtual	~StateMapping ()=default

Protected Attributes
std::shared_ptr< OutputStateType >	output_
	Last computet output state. More...
std::shared_ptr< ParamType >	params_
	Pointer to the class parameters object. More...

Detailed Description

template<typename InputStateType, typename OutputStateType, typename ParamType>
class tuw::StateMapping< InputStateType, OutputStateType, ParamType >

Interface for a filter that performs a (nonlinear) mapping from the input state to an output state.

Template Parameters

InputStateType	Class defining the current state of the afferent system
OutputStateType	Class defining the computed state of the filter
ParamType	Class defining the filter parameters

Definition at line 48 of file state_mapping.hpp.

Constructor & Destructor Documentation

template<typename InputStateType , typename OutputStateType , typename ParamType >

tuw::StateMapping< InputStateType, OutputStateType, ParamType >::StateMapping ( std::shared_ptr< ParamType > &  _params )

inline

Definition at line 52 of file state_mapping.hpp.

template<typename InputStateType , typename OutputStateType , typename ParamType >

virtual tuw::StateMapping< InputStateType, OutputStateType, ParamType >::~StateMapping ( )

virtualdefault

template<typename InputStateType , typename OutputStateType , typename ParamType >

tuw::StateMapping< InputStateType, OutputStateType, ParamType >::StateMapping ( const StateMapping< InputStateType, OutputStateType, ParamType > &  )

default

template<typename InputStateType , typename OutputStateType , typename ParamType >

tuw::StateMapping< InputStateType, OutputStateType, ParamType >::StateMapping ( StateMapping< InputStateType, OutputStateType, ParamType > &&  )

default

Member Function Documentation

template<typename InputStateType , typename OutputStateType , typename ParamType >

virtual std::shared_ptr<OutputStateType>& tuw::StateMapping< InputStateType, OutputStateType, ParamType >::compute ( std::shared_ptr< InputStateType > &  _x, const double &  _t  )

pure virtual

Computes the output state after a (nonlinear) state mapping.

Parameters

_x	Input state
_t	Actual temporal evaluation point

Returns

Output state

template<typename InputStateType , typename OutputStateType , typename ParamType >

StateMapping& tuw::StateMapping< InputStateType, OutputStateType, ParamType >::operator= ( const StateMapping< InputStateType, OutputStateType, ParamType > &  )

default

template<typename InputStateType , typename OutputStateType , typename ParamType >

StateMapping& tuw::StateMapping< InputStateType, OutputStateType, ParamType >::operator= ( StateMapping< InputStateType, OutputStateType, ParamType > &&  )

default

template<typename InputStateType , typename OutputStateType , typename ParamType >

std::shared_ptr<OutputStateType>& tuw::StateMapping< InputStateType, OutputStateType, ParamType >::output ( )

inline

Access to the last computed output state.

Definition at line 87 of file state_mapping.hpp.

template<typename InputStateType , typename OutputStateType , typename ParamType >

virtual void tuw::StateMapping< InputStateType, OutputStateType, ParamType >::reloadParam ( )

pure virtual

Reloads class parameters. To be called when parameters that influence the class variables are changed.

Member Data Documentation

template<typename InputStateType , typename OutputStateType , typename ParamType >

std::shared_ptr<OutputStateType> tuw::StateMapping< InputStateType, OutputStateType, ParamType >::output_

protected

Last computet output state.

Definition at line 95 of file state_mapping.hpp.

template<typename InputStateType , typename OutputStateType , typename ParamType >

std::shared_ptr<ParamType> tuw::StateMapping< InputStateType, OutputStateType, ParamType >::params_

protected

Pointer to the class parameters object.

Definition at line 93 of file state_mapping.hpp.

---

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

• state_mapping.hpp