Parametrizable Class Reference

using ParameterList = std::list<matrix::Matrix>; More...

#include <parametrizable.h>

Inheritance diagram for Parametrizable:

Public Member Functions
virtual	~Parametrizable ()
virtual ParameterList	getParameters () const =0
	Returns a list of matrices that parametrize the controller. More...
virtual int	setParameters (const ParameterList &params)=0
	sets the parameters. More...

Detailed Description

using ParameterList = std::list<matrix::Matrix>;

Interface for parametrizable controller. Which expose a set of parameters that be set from outside.

Constructor & Destructor Documentation

virtual ~Parametrizable ( )

inlinevirtual

Member Function Documentation

virtual ParameterList getParameters ( ) const

pure virtual

Returns a list of matrices that parametrize the controller.

Implemented in Sox, SeMoX, and PiMax.

virtual int setParameters ( const ParameterList &  params )

pure virtual

sets the parameters.

The list must have the same length as returned by getParameters() The matrix dimensions must fit those given by getParameters()

Returns

0 for failure, 1 for success and 2 if parameters had been changed during setting (to be valid) such that a get is required to get the actual values

Implemented in Sox, SeMoX, and PiMax.

---

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

• parametrizable.h