Interface for a filter that outputs a desired state given an observed state and a parametric functions structure. More...
#include <param_funcs_to_state.hpp>
Inheritance diagram for tuw::ParamFuncs2State< InputStateType, ParamFuncsType, OutputStateType, ParamType >:
Public Types | |
| using | ParamFuncType = ParamFuncsType |
| Parametric functions class type. More... | |
Public Member Functions | |
| virtual std::shared_ptr< OutputStateType > & | compute (std::shared_ptr< InputStateType > &_x, std::shared_ptr< ParamFuncsType > &_funcs, const double &_t)=0 |
| Computes the desired state at the specified time instant given the observed state and a parametric functions structure. More... | |
| ParamFuncs2State & | operator= (const ParamFuncs2State &)=default |
| ParamFuncs2State & | operator= (ParamFuncs2State &&)=default |
| std::shared_ptr< OutputStateType > & | output () |
| Access to the last computed output state. More... | |
| ParamFuncs2State (std::shared_ptr< ParamType > _params) | |
| ParamFuncs2State (const ParamFuncs2State &)=default | |
| ParamFuncs2State (ParamFuncs2State &&)=default | |
| virtual | ~ParamFuncs2State ()=default |
 Public Member Functions inherited from tuw::ParamFuncs2StateBase | |
| virtual bool | finished () const =0 |
| Returns wether the parametric functions evaluation has reached the end of the parametric functions domain definition. More... | |
| virtual void | reloadParam ()=0 |
| Reloads class parameters. To be called when parameters that influence the class variables are changed. More... | |
| virtual void | reset ()=0 |
| Resets class structures/variables. More... | |
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 ParamFuncsType, typename OutputStateType, typename ParamType>
class tuw::ParamFuncs2State< InputStateType, ParamFuncsType, OutputStateType, ParamType >
Interface for a filter that outputs a desired state given an observed state and a parametric functions structure.
- Template Parameters
-
InputStateType Class defining the current (observed) state of the afferent system ParamFuncsType Class defining the parametric functions structure to be evaluated (e.g. multivariate splines) OutputStateType Class defining the computed state of the filter ParamType Class defining the filter parameters
Definition at line 73 of file param_funcs_to_state.hpp.
Member Typedef Documentation
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
| using tuw::ParamFuncs2State< InputStateType, ParamFuncsType, OutputStateType, ParamType >::ParamFuncType = ParamFuncsType |
Parametric functions class type.
Definition at line 97 of file param_funcs_to_state.hpp.
Constructor & Destructor Documentation
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
|
inline |
Definition at line 77 of file param_funcs_to_state.hpp.
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
|
virtualdefault |
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
|
default |
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
|
default |
Member Function Documentation
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
|
pure virtual |
Computes the desired state at the specified time instant given the observed state and a parametric functions structure.
- Parameters
-
_x Observed state _funcs Parametric functions structure _t Temporal evaluation point
- Returns
- computed output state
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
|
default |
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
|
default |
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
|
inline |
Access to the last computed output state.
Definition at line 114 of file param_funcs_to_state.hpp.
Member Data Documentation
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
|
protected |
Last computet output state.
Definition at line 122 of file param_funcs_to_state.hpp.
template<typename InputStateType , typename ParamFuncsType , typename OutputStateType , typename ParamType >
|
protected |
Pointer to the class parameters object.
Definition at line 120 of file param_funcs_to_state.hpp.
The documentation for this class was generated from the following file: