FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kTempControl Class Reference

Description

Represents configuration for (PID) temperature regulation.

Inheritance diagram for kTempControl:
Inheritance graph

Public Member Functions

kStatus kTempControl_Clear (kTempControl control)
 Resets temperature regulation settings to defaults. More...
 
k64f kTempControl_Dt (kTempControl control)
 Reports the current dt setting. More...
 
kStatus kTempControl_DtInfo (kTempControl control, kInfo64f *info)
 Reports constraint and validity information for the Dt setting. More...
 
kStatus kTempControl_Enable (kTempControl control, kBool enable)
 Enables or disables the temperature regulation. More...
 
kStatus kTempControl_EnabledInfo (kTempControl control, kInfoBool *info)
 Reports constraint and validity information for the Enabled setting. More...
 
k64f kTempControl_IntegratorMax (kTempControl control)
 Reports the current integratorMax setting. More...
 
kStatus kTempControl_IntegratorMaxInfo (kTempControl control, kInfo64f *info)
 Reports constraint and validity information for the IntegratorMax setting. More...
 
kBool kTempControl_IsEnabled (kTempControl control)
 Reports whether the temperature regulation is currently enabled. More...
 
k64f kTempControl_Kd (kTempControl control)
 Reports the current kd setting. More...
 
kStatus kTempControl_KdInfo (kTempControl control, kInfo64f *info)
 Reports constraint and validity information for the Kd setting. More...
 
k64f kTempControl_Ki (kTempControl control)
 Reports the current ki setting. More...
 
kStatus kTempControl_KiInfo (kTempControl control, kInfo64f *info)
 Reports constraint and validity information for the Ki setting. More...
 
k64f kTempControl_Kp (kTempControl control)
 Reports the current kp setting. More...
 
kStatus kTempControl_KpInfo (kTempControl control, kInfo64f *info)
 Reports constraint and validity information for the Kp setting. More...
 
k64f kTempControl_Ks (kTempControl control)
 Reports the current ks setting. More...
 
kStatus kTempControl_KsInfo (kTempControl control, kInfo64f *info)
 Reports constraint and validity information for the Ks setting. More...
 
k64f kTempControl_Max (kTempControl control)
 Reports the current max setting. More...
 
kStatus kTempControl_MaxInfo (kTempControl control, kInfo64f *info)
 Reports constraint and validity information for the Max setting. More...
 
k64f kTempControl_Min (kTempControl control)
 Reports the current min setting. More...
 
kStatus kTempControl_MinInfo (kTempControl control, kInfo64f *info)
 Reports constraint and validity information for the Min setting. More...
 
kStatus kTempControl_SetDt (kTempControl control, k64f dt)
 Sets the dt. More...
 
kStatus kTempControl_SetIntegratorMax (kTempControl control, k64f integratorMax)
 Sets the integratorMax. More...
 
kStatus kTempControl_SetKd (kTempControl control, k64f kd)
 Sets the kd. More...
 
kStatus kTempControl_SetKi (kTempControl control, k64f ki)
 Sets the ki. More...
 
kStatus kTempControl_SetKp (kTempControl control, k64f kp)
 Sets the kp. More...
 
kStatus kTempControl_SetKs (kTempControl control, k64f ks)
 Sets the ks. More...
 
kStatus kTempControl_SetMax (kTempControl control, k64f max)
 Sets the max. More...
 
kStatus kTempControl_SetMin (kTempControl control, k64f min)
 Sets the min. More...
 
k64f kTempControl_Setpoint (kTempControl control)
 Reports the current setpoint setting. More...
 
kStatus kTempControl_SetpointInfo (kTempControl control, kInfo64f *info)
 Reports constraint and validity information for the Setpoint setting. More...
 
kStatus kTempControl_SetSetpoint (kTempControl control, k64f setpoint)
 Sets the setpoint. More...
 

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