Maria GDK 5.0.0.738
Documentation of native code in develop branch
Loading...
Searching...
No Matches
Public Member Functions | List of all members
STK::PidControlClass< Type > Class Template Reference

Public Member Functions

void setPID (bool p, bool i, bool d)
 
bool getP () const
 
bool getI () const
 
bool getD () const
 
void setUMax (Type v)
 
void setUMin (Type v)
 
void setKP (Type kp)
 
void setTI (Type ti)
 
void setTD (Type td)
 
Type getKP () const
 
Type getTI () const
 
Type getTD () const
 
void setDf (Type df)
 
Type getDf () const
 
Type getIntegrator () const
 
Type getDerivator () const
 
Type update (Type error, Type dt)
 
void reset ()
 
void setPrevU (Type prev_u)
 

Member Function Documentation

◆ setKP()

template<class Type >
void STK::PidControlClass< Type >::setKP ( Type  kp)
inline

Set the proportional gain

◆ setPID()

template<class Type >
void STK::PidControlClass< Type >::setPID ( bool  p,
bool  i,
bool  d 
)
inline

Enable/disable proportional controller, integrator and derivator

◆ setTD()

template<class Type >
void STK::PidControlClass< Type >::setTD ( Type  td)
inline

Set the derivator time constant

◆ setTI()

template<class Type >
void STK::PidControlClass< Type >::setTI ( Type  ti)
inline

Set the integrator time constant

◆ update()

template<class Type >
Type STK::PidControlClass< Type >::update ( Type  error,
Type  dt 
)
inline

Step the controller. The controller will try to adjust the output to keep "error" at 0.0.

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