Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
PIDclamp Class Reference
Inheritance diagram for PIDclamp:
IPid

Public Member Functions

void ClampIntegral (float limit, bool isEnabled)
 
 PIDclamp (string name, float kp, float ki, float kd, float clamp)
 
void Reinitialize (string name, float kp, float ki, float kd)
 
void Reinitialize (float kp, float ki, float kd)
 
void Reset ()
 
void ResetIntegral ()
 
override string ToString ()
 
double Update (double error, double dt)
 
float Update (float error, float dt)
 

Static Public Member Functions

static implicit operator double (PIDclamp v)
 
static PIDclamp Parse (string s)
 

Public Attributes

double clamp
 Defines maximum and minimum for PID "output" value. More...
 
float clampScalar = 1.0f
 
bool ignoreIntegral = false
 Ignore integral when this is active. More...
 
float kdScalar = 1.0f
 
float kiScalar = 1.0f
 
double kp
 
float kpScalar = 1.0f
 
string name
 PID name, for external tracking purposes only. More...
 
float tuningScalar = 1.0f
 Global "realtime" scalars for kp, ki, and kd. More...
 

Constructor & Destructor Documentation

PIDclamp.PIDclamp ( string  name,
float  kp,
float  ki,
float  kd,
float  clamp 
)
inline

Member Function Documentation

void PIDclamp.ClampIntegral ( float  limit,
bool  isEnabled 
)
inline
static implicit PIDclamp.operator double ( PIDclamp  v)
inlinestatic
static PIDclamp PIDclamp.Parse ( string  s)
inlinestatic
void PIDclamp.Reinitialize ( string  name,
float  kp,
float  ki,
float  kd 
)
inline
void PIDclamp.Reinitialize ( float  kp,
float  ki,
float  kd 
)
inline
void PIDclamp.Reset ( )
inline
void PIDclamp.ResetIntegral ( )
inline
override string PIDclamp.ToString ( )
inline
double PIDclamp.Update ( double  error,
double  dt 
)
inline

< Meat of the PID calculation

< Clamp the output. If clamped, remove the integral accumulation.

float PIDclamp.Update ( float  error,
float  dt 
)
inline

Implements IPid.

Member Data Documentation

double PIDclamp.clamp

Defines maximum and minimum for PID "output" value.

float PIDclamp.clampScalar = 1.0f
bool PIDclamp.ignoreIntegral = false

Ignore integral when this is active.

float PIDclamp.kdScalar = 1.0f
float PIDclamp.kiScalar = 1.0f
double PIDclamp.kp
float PIDclamp.kpScalar = 1.0f
string PIDclamp.name

PID name, for external tracking purposes only.

float PIDclamp.tuningScalar = 1.0f

Global "realtime" scalars for kp, ki, and kd.


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