libstp::autotune::control::ControlElementP Class Reference

Proportional element: y = K * u. Port of ControlElementP.ts. More...

#include <control_elements.hpp>

Inheritance diagram for libstp::autotune::control::ControlElementP:

Collaboration diagram for libstp::autotune::control::ControlElementP:

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

Detailed Description

Proportional element: y = K * u. Port of ControlElementP.ts.

Definition at line 17 of file control_elements.hpp.

Constructor & Destructor Documentation

ControlElementP()

libstp::autotune::control::ControlElementP::ControlElementP ( double k )

inlineexplicit

Definition at line 20 of file control_elements.hpp.

Member Function Documentation

calculate()

double libstp::autotune::control::ControlElementP::calculate ( double u, double dt )

inlineoverridevirtual

Advance one sample: feed input u, return output.

Implements libstp::autotune::control::ControlElement.

Definition at line 25 of file control_elements.hpp.

getLowestTimeConstant()

double libstp::autotune::control::ControlElementP::getLowestTimeConstant ( ) const

inlinenodiscardoverridevirtual

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

Implements libstp::autotune::control::ControlElement.

Definition at line 23 of file control_elements.hpp.

getType()

std::string libstp::autotune::control::ControlElementP::getType ( ) const

inlinenodiscardoverridevirtual

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

Implements libstp::autotune::control::ControlElement.

Definition at line 22 of file control_elements.hpp.

initialize()

void libstp::autotune::control::ControlElementP::initialize ( double dt )

inlineoverridevirtual

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

Implements libstp::autotune::control::ControlElement.

Definition at line 24 of file control_elements.hpp.

optimizeGetNumParameters()

int libstp::autotune::control::ControlElementP::optimizeGetNumParameters ( ) const

inlinenodiscardoverridevirtual

Number of tunable parameters this element consumes.

Implements libstp::autotune::control::ControlElement.

Definition at line 26 of file control_elements.hpp.

optimizeSetParameters()

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

inlineoverridevirtual

Load parameters from params starting at startIdx.

Implements libstp::autotune::control::ControlElement.

Definition at line 27 of file control_elements.hpp.

---

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_elements.hpp