Class PIDParamsVars

Contents

Class PIDParamsVars#

Defined in File PID.h

Inheritance Relationships#

Base Type#

public Karana::Core::BaseVars (Class BaseVars)

Class Documentation#

class PIDParamsVars : public Karana::Core::BaseVars #

The Vars for the PIDParams class.

Public Functions

PIDParamsVars(const kc::ks_ptr<const PIDParams> &body)#

PIDParamsVars constructor. The constructor is not meant to be called directly. Please use the create(…) method instead to create an instance.

Parameters:: body – The body associated with this PIDParamsVars.

~PIDParamsVars()#: Destructor.

virtual kc::NestedVars getAllVars() const override#

Get all the Vars that this PIDParamsVars has.

Returns:: A map of Vars, where the Var name is the key and the Var is the value.

Public Members

kc::ks_ptr<Karana::Core::Var_T<double>> kp#: Proportional gain.

kc::ks_ptr<Karana::Core::Var_T<double>> kd#: Derivative gain.

kc::ks_ptr<Karana::Core::Var_T<double>> ki#: Integral gain.

Public Static Functions

static kc::ks_ptr<PIDParamsVars> create(const kc::ks_ptr<const PIDParams> &body)#

Create an instance of the PIDParamsVars.

Parameters:: body – The body associated with this PIDParamsVars.
Returns:: A pointer to the newly created instance of PIDParamsVars.