AnimatLab  2
Test
StdUtils::CStdPID Class Reference

Implements a basic PID control algorithm. More...

#include <StdPID.h>

+ Collaboration diagram for StdUtils::CStdPID:

Public Member Functions

 CStdPID (float fltSetpoint, float fltGain, float fltIntegralAct, float fltDerivativeAct, bool bComplexError, bool bAntiResetWindup, bool bRampLimit, float fltRangeMax, float fltRangeMin, float fltARWBound, float fltRampGradient)
 
virtual void AntiResetWindup (bool bVal)
 
virtual bool AntiResetWindup ()
 
virtual void ARWBound (float fltVal)
 Sets the anti-reset boundary. This is specified as a percentage of the entire output range. A limit of zero percent would make output ARW impossible and a limit of 50 percent or greater would allow maximum ARW. More...
 
virtual float ARWBound ()
 
virtual float Calculate (float fltDt, float fltInput)
 
virtual void ComplexError (bool bVal)
 
virtual bool ComplexError ()
 
virtual float Derivative ()
 
virtual void DerivativeAct (float fltVal)
 
virtual float DerivativeAct ()
 
virtual float Error ()
 
virtual float ErrorChange ()
 
virtual void Gain (float fltVal)
 
virtual float Gain ()
 
virtual float Integral ()
 
virtual void IntegralAct (float fltVal)
 
virtual float IntegralAct ()
 
virtual float OldIntegral ()
 
virtual float OldOutput ()
 
virtual float Output ()
 
virtual float Proportional ()
 
virtual void RampGradient (float fltVal)
 Ramp gradient. More...
 
virtual float RampGradient ()
 
virtual void RampLimit (bool bVal)
 
virtual bool RampLimit ()
 
virtual float Range ()
 
virtual void RangeMax (float fltVal)
 
virtual float RangeMax ()
 
virtual void RangeMin (float fltVal)
 
virtual float RangeMin ()
 
virtual void ResetVars ()
 
virtual void Setpoint (float fltVal)
 
virtual float Setpoint ()
 

Protected Member Functions

virtual void FullReset ()
 

Protected Attributes

CStdCircularArray< float > m_aryOldErrors
 
bool m_bAntiResetWindup
 
bool m_bComplexError
 
bool m_bRampLimit
 
float m_fltARWBound
 
float m_fltDerivative
 
float m_fltDerivativeAct
 
float m_fltError
 
float m_fltErrorChange
 
float m_fltGain
 
float m_fltIntegral
 
float m_fltIntegralAct
 
float m_fltOldIntegral
 
float m_fltOldOutput
 
float m_fltOutput
 
float m_fltProportional
 
float m_fltRampGradient
 
float m_fltRange
 
float m_fltRangeMax
 
float m_fltRangeMin
 
float m_fltSetpoint
 

Detailed Description

Implements a basic PID control algorithm.

Author
David Cofer
Date
1/10/2014

Definition at line 17 of file StdPID.h.

Member Function Documentation

void CStdPID::ARWBound ( float  fltVal)
virtual

Sets the anti-reset boundary. This is specified as a percentage of the entire output range. A limit of zero percent would make output ARW impossible and a limit of 50 percent or greater would allow maximum ARW.

Author
David Cofer
Date
1/10/2014
Parameters
fltValThe new value.

Definition at line 190 of file StdPID.cpp.

void CStdPID::RampGradient ( float  fltVal)
virtual

Ramp gradient.

Author
David Cofer
Date
1/10/2014
Parameters
fltValThe new degree value.

Definition at line 206 of file StdPID.cpp.


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