libstp::autotune::control::ControlElement Class Reference

Abstract base for every control element (P, I, D, PT1, ...). More...

#include <control_element.hpp>

Inheritance diagram for libstp::autotune::control::ControlElement:

Public Member Functions
virtual	~ControlElement ()=default
virtual std::string	getType () const =0
	Short type tag, e.g. "P", "PT1", "ControlLoop".
virtual double	getLowestTimeConstant () const =0
	Lowest time constant of the element, or -1 if it has none.
virtual void	initialize (double dt)=0
	Reset internal state for a simulation run at sample time dt.
virtual double	calculate (double u, double dt)=0
	Advance one sample: feed input u, return output.
virtual int	optimizeGetNumParameters () const =0
	Number of tunable parameters this element consumes.
virtual void	optimizeSetParameters (const std::vector< double > &params, int startIdx)=0
	Load parameters from params starting at startIdx.

Detailed Description

Abstract base for every control element (P, I, D, PT1, ...).

Faithful port of ControlElement.ts. Implements the optimization interface (IControlOptimization) directly: every element exposes how many tunable parameters it has and how to write a flat parameter vector into its state.

Definition at line 25 of file control_element.hpp.

Constructor & Destructor Documentation

~ControlElement()

virtual libstp::autotune::control::ControlElement::~ControlElement ( )

virtualdefault

Member Function Documentation

calculate()

virtual double libstp::autotune::control::ControlElement::calculate ( double u, double dt )

pure virtual

Advance one sample: feed input u, return output.

Implemented in libstp::autotune::control::ControlElementD, libstp::autotune::control::ControlElementDeadTime, libstp::autotune::control::ControlElementI, libstp::autotune::control::ControlElementP, libstp::autotune::control::ControlElementPD1, libstp::autotune::control::ControlElementPID, libstp::autotune::control::ControlElementPT1, libstp::autotune::control::ControlElementPT2, libstp::autotune::control::ControlLoop, and libstp::autotune::control::ControlPath.

getLowestTimeConstant()

virtual double libstp::autotune::control::ControlElement::getLowestTimeConstant ( ) const

nodiscardpure virtual

Lowest time constant of the element, or -1 if it has none.

Implemented in libstp::autotune::control::ControlElementD, libstp::autotune::control::ControlElementDeadTime, libstp::autotune::control::ControlElementI, libstp::autotune::control::ControlElementP, libstp::autotune::control::ControlElementPD1, libstp::autotune::control::ControlElementPID, libstp::autotune::control::ControlElementPT1, libstp::autotune::control::ControlElementPT2, libstp::autotune::control::ControlLoop, and libstp::autotune::control::ControlPath.

getType()

virtual std::string libstp::autotune::control::ControlElement::getType ( ) const

nodiscardpure virtual

Short type tag, e.g. "P", "PT1", "ControlLoop".

Implemented in libstp::autotune::control::ControlElementD, libstp::autotune::control::ControlElementDeadTime, libstp::autotune::control::ControlElementI, libstp::autotune::control::ControlElementP, libstp::autotune::control::ControlElementPD1, libstp::autotune::control::ControlElementPID, libstp::autotune::control::ControlElementPT1, libstp::autotune::control::ControlElementPT2, libstp::autotune::control::ControlLoop, and libstp::autotune::control::ControlPath.

initialize()

virtual void libstp::autotune::control::ControlElement::initialize ( double dt )

pure virtual

Reset internal state for a simulation run at sample time dt.

Implemented in libstp::autotune::control::ControlElementD, libstp::autotune::control::ControlElementDeadTime, libstp::autotune::control::ControlElementI, libstp::autotune::control::ControlElementP, libstp::autotune::control::ControlElementPD1, libstp::autotune::control::ControlElementPID, libstp::autotune::control::ControlElementPT1, libstp::autotune::control::ControlElementPT2, libstp::autotune::control::ControlLoop, and libstp::autotune::control::ControlPath.

optimizeGetNumParameters()

virtual int libstp::autotune::control::ControlElement::optimizeGetNumParameters ( ) const

nodiscardpure virtual

Number of tunable parameters this element consumes.

Implemented in libstp::autotune::control::ControlElementD, libstp::autotune::control::ControlElementDeadTime, libstp::autotune::control::ControlElementI, libstp::autotune::control::ControlElementP, libstp::autotune::control::ControlElementPD1, libstp::autotune::control::ControlElementPID, libstp::autotune::control::ControlElementPT1, libstp::autotune::control::ControlElementPT2, libstp::autotune::control::ControlLoop, and libstp::autotune::control::ControlPath.

optimizeSetParameters()

virtual void libstp::autotune::control::ControlElement::optimizeSetParameters ( const std::vector< double > & params, int startIdx )

pure virtual

Load parameters from params starting at startIdx.

Implemented in libstp::autotune::control::ControlElementD, libstp::autotune::control::ControlElementDeadTime, libstp::autotune::control::ControlElementI, libstp::autotune::control::ControlElementP, libstp::autotune::control::ControlElementPD1, libstp::autotune::control::ControlElementPID, libstp::autotune::control::ControlElementPT1, libstp::autotune::control::ControlElementPT2, libstp::autotune::control::ControlLoop, and libstp::autotune::control::ControlPath.

---

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

• /home/runner/work/raccoon-lib/raccoon-lib/modules/libstp-autotune/include/autotune/control/control_element.hpp