FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kAnalogOut.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_ANALOG_OUT_H
9 #define K_FIRESYNC_ANALOG_OUT_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kAnalogOut; --forward-declared in kFsDef.x.h
22 
23 
30 kFsFx(kSize) kAnalogOut_Id(kAnalogOut analog);
31 
39 kFsFx(kStatus) kAnalogOut_Clear(kAnalogOut analog);
40 
52 kFsFx(kStatus) kAnalogOut_Enable(kAnalogOut analog, kBool enable);
53 
62 
75 
84 
94 
107 
115 kFsFx(k32u) kAnalogOut_ControlId(kAnalogOut analog);
116 
125 kFsFx(kStatus) kAnalogOut_ControlIdInfo(kAnalogOut analog, kInfo* info);
126 
139 kFsFx(kStatus) kAnalogOut_SetCalA0(kAnalogOut analog, k64f a0);
140 
148 kFsFx(k64f) kAnalogOut_CalA0(kAnalogOut analog);
149 
162 kFsFx(kStatus) kAnalogOut_SetCalA1(kAnalogOut analog, k64f a1);
163 
171 kFsFx(k64f) kAnalogOut_CalA1(kAnalogOut analog);
172 
180 kFsFx(k32u) kAnalogOut_MaxValue(kAnalogOut analog);
181 
192 kFsFx(k64f) kAnalogOut_MinCurrent(kAnalogOut analog);
193 
204 kFsFx(k64f) kAnalogOut_MaxCurrent(kAnalogOut analog);
205 
218 kFsFx(kStatus) kAnalogOut_EnqueueValue(kAnalogOut analog, k32u value);
219 
232 kFsFx(kStatus) kAnalogOut_EnqueueCurrent(kAnalogOut analog, k64f current);
233 
242 kFsFx(kStatus) kAnalogOut_Stats(kAnalogOut analog, kAnalogOutStats* stats);
243 
244 kEndHeader()
245 
246 #include <kFireSync/Client/kAnalogOut.x.h>
247 
248 #endif
kStatus kAnalogOut_EnqueueValue(kAnalogOut analog, k32u value)
Enqueues an analog output value, in raw digital-to-analog units.
kStatus kAnalogOut_EnqueueCurrent(kAnalogOut analog, k64f current)
Enqueues an analog output value, in milliamps.
kStatus kAnalogOut_ControlIdInfo(kAnalogOut analog, kInfo *info)
Reports constraint and validity information for the ControlId setting.
k32u kAnalogOut_MaxValue(kAnalogOut analog)
Maximum the analog output value.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:454
k64f kAnalogOut_MaxCurrent(kAnalogOut analog)
Gets the current, in milliamps, corresponding to the maximum analog output value. ...
Essential declarations related to FireSync nodes.
k64f kAnalogOut_CalA0(kAnalogOut analog)
Gets analog output calibration coefficient a0.
kStatus kAnalogOut_SetCalA0(kAnalogOut analog, k64f a0)
Sets analog output calibration coefficient a0.
kStatus kAnalogOut_ControlInfo(kAnalogOut analog, kInfoBits *info)
Reports constraint and validity information for the Control setting.
kSize kAnalogOut_Id(kAnalogOut analog)
Gets the id of the output.
kStatus kAnalogOut_Clear(kAnalogOut analog)
Re-initializes settings.
k64f kAnalogOut_MinCurrent(kAnalogOut analog)
Gets the current, in milliamps, corresponding to the minimum analog output value (0).
Represents analog configuration.
kStatus kAnalogOut_SetCalA1(kAnalogOut analog, k64f a1)
Sets analog output calibration coefficient a1.
kStatus kAnalogOut_SetControl(kAnalogOut analog, kAnalogOutControl type)
Sets the control mode of the analog output.
k32u kAnalogOut_ControlId(kAnalogOut analog)
Gets the control source id for an analog output.
Represents analog output control modes.
kBool kAnalogOut_IsEnabled(kAnalogOut analog)
Reports whether the analog output is currently enabled.
kStatus kAnalogOut_Stats(kAnalogOut analog, kAnalogOutStats *stats)
Retrieve statistics for this analog output module.
Represents analog output run-time statistics.
Definition: kNodeDef.h:1130
kAnalogOutControl kAnalogOut_Control(kAnalogOut analog)
Reports the control mode of the analog output.
kStatus kAnalogOut_Enable(kAnalogOut analog, kBool enable)
Enables or disables the analog output.
kStatus kAnalogOut_SetControlId(kAnalogOut analog, k32u id)
Sets the control source id for an analog output.
Represents constraint and validity information for a general setting.
Definition: kInfo.h:45
k64f kAnalogOut_CalA1(kAnalogOut analog)
Gets analog output calibration coefficient a1.