FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kTempControl.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_LIGHT_TEMP_H
9 #define K_FIRESYNC_LIGHT_TEMP_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kTempControl; --forward-declared in kFsDef.x.h
20 
29 
38 kFsFx(kStatus) kTempControl_Enable(kTempControl control, kBool enable);
39 
48 
58 
67 kFsFx(kStatus) kTempControl_SetSetpoint(kTempControl control, k64f setpoint);
68 
77 
87 
96 kFsFx(kStatus) kTempControl_SetDt(kTempControl control, k64f dt);
97 
105 kFsFx(k64f) kTempControl_Dt(kTempControl control);
106 
115 kFsFx(kStatus) kTempControl_DtInfo(kTempControl control, kInfo64f* info);
116 
125 kFsFx(kStatus) kTempControl_SetKp(kTempControl control, k64f kp);
126 
134 kFsFx(k64f) kTempControl_Kp(kTempControl control);
135 
144 kFsFx(kStatus) kTempControl_KpInfo(kTempControl control, kInfo64f* info);
145 
154 kFsFx(kStatus) kTempControl_SetKi(kTempControl control, k64f ki);
155 
163 kFsFx(k64f) kTempControl_Ki(kTempControl control);
164 
173 kFsFx(kStatus) kTempControl_KiInfo(kTempControl control, kInfo64f* info);
174 
183 kFsFx(kStatus) kTempControl_SetKd(kTempControl control, k64f kd);
184 
192 kFsFx(k64f) kTempControl_Kd(kTempControl control);
193 
202 kFsFx(kStatus) kTempControl_KdInfo(kTempControl control, kInfo64f* info);
203 
212 kFsFx(kStatus) kTempControl_SetKs(kTempControl control, k64f ks);
213 
221 kFsFx(k64f) kTempControl_Ks(kTempControl control);
222 
231 kFsFx(kStatus) kTempControl_KsInfo(kTempControl control, kInfo64f* info);
232 
241 kFsFx(kStatus) kTempControl_SetMin(kTempControl control, k64f min);
242 
250 kFsFx(k64f) kTempControl_Min(kTempControl control);
251 
260 kFsFx(kStatus) kTempControl_MinInfo(kTempControl control, kInfo64f* info);
261 
270 kFsFx(kStatus) kTempControl_SetMax(kTempControl control, k64f max);
271 
279 kFsFx(k64f) kTempControl_Max(kTempControl control);
280 
289 kFsFx(kStatus) kTempControl_MaxInfo(kTempControl control, kInfo64f* info);
290 
299 kFsFx(kStatus) kTempControl_SetIntegratorMax(kTempControl control, k64f integratorMax);
300 
309 
319 
320 #include <kFireSync/Client/kTempControl.x.h>
321 
322 #endif
k64f kTempControl_IntegratorMax(kTempControl control)
Reports the current integratorMax setting.
kStatus kTempControl_Clear(kTempControl control)
Resets temperature regulation settings to defaults.
kStatus kTempControl_SetKs(kTempControl control, k64f ks)
Sets the ks.
kStatus kTempControl_MaxInfo(kTempControl control, kInfo64f *info)
Reports constraint and validity information for the Max setting.
k64f kTempControl_Kd(kTempControl control)
Reports the current kd setting.
kStatus kTempControl_DtInfo(kTempControl control, kInfo64f *info)
Reports constraint and validity information for the Dt setting.
Represents constraint and validity information for a double setting.
Definition: kInfo.h:438
k64f kTempControl_Min(kTempControl control)
Reports the current min setting.
kStatus kTempControl_SetSetpoint(kTempControl control, k64f setpoint)
Sets the setpoint.
Essential declarations related to FireSync nodes.
kStatus kTempControl_SetDt(kTempControl control, k64f dt)
Sets the dt.
kStatus kTempControl_IntegratorMaxInfo(kTempControl control, kInfo64f *info)
Reports constraint and validity information for the IntegratorMax setting.
kStatus kTempControl_SetKp(kTempControl control, k64f kp)
Sets the kp.
k64f kTempControl_Ks(kTempControl control)
Reports the current ks setting.
k64f kTempControl_Kp(kTempControl control)
Reports the current kp setting.
kStatus kTempControl_SetKd(kTempControl control, k64f kd)
Sets the kd.
k64f kTempControl_Dt(kTempControl control)
Reports the current dt setting.
kStatus kTempControl_EnabledInfo(kTempControl control, kInfoBool *info)
Reports constraint and validity information for the Enabled setting.
kStatus kTempControl_SetIntegratorMax(kTempControl control, k64f integratorMax)
Sets the integratorMax.
k64f kTempControl_Setpoint(kTempControl control)
Reports the current setpoint setting.
kStatus kTempControl_SetKi(kTempControl control, k64f ki)
Sets the ki.
kStatus kTempControl_KdInfo(kTempControl control, kInfo64f *info)
Reports constraint and validity information for the Kd setting.
kStatus kTempControl_KiInfo(kTempControl control, kInfo64f *info)
Reports constraint and validity information for the Ki setting.
kStatus kTempControl_SetMax(kTempControl control, k64f max)
Sets the max.
kStatus kTempControl_MinInfo(kTempControl control, kInfo64f *info)
Reports constraint and validity information for the Min setting.
kStatus kTempControl_KpInfo(kTempControl control, kInfo64f *info)
Reports constraint and validity information for the Kp setting.
kStatus kTempControl_SetMin(kTempControl control, k64f min)
Sets the min.
kBool kTempControl_IsEnabled(kTempControl control)
Reports whether the temperature regulation is currently enabled.
Represents configuration for (PID) temperature regulation.
k64f kTempControl_Max(kTempControl control)
Reports the current max setting.
k64f kTempControl_Ki(kTempControl control)
Reports the current ki setting.
kStatus kTempControl_SetpointInfo(kTempControl control, kInfo64f *info)
Reports constraint and validity information for the Setpoint setting.
kStatus kTempControl_KsInfo(kTempControl control, kInfo64f *info)
Reports constraint and validity information for the Ks setting.
kStatus kTempControl_Enable(kTempControl control, kBool enable)
Enables or disables the temperature regulation.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:493