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 
19 //typedef kObject kAnalogOut; --forward-declared in kFsDef.x.h
20 
28 kFsFx(kSize) kAnalogOut_Id(kAnalogOut analog);
29 
37 kFsFx(kStatus) kAnalogOut_Clear(kAnalogOut analog);
38 
50 kFsFx(kStatus) kAnalogOut_Enable(kAnalogOut analog, kBool enable);
51 
59 kFsFx(kBool) kAnalogOut_IsEnabled(kAnalogOut analog);
60 
72 kFsFx(kStatus) kAnalogOut_SetControl(kAnalogOut analog, kAnalogOutControl type);
73 
81 kFsFx(kAnalogOutControl) kAnalogOut_Control(kAnalogOut analog);
82 
91 kFsFx(kStatus) kAnalogOut_ControlInfo(kAnalogOut analog, kInfoBits* info);
92 
104 kFsFx(kStatus) kAnalogOut_SetControlId(kAnalogOut analog, k32u id);
105 
113 kFsFx(k32u) kAnalogOut_ControlId(kAnalogOut analog);
114 
123 kFsFx(kStatus) kAnalogOut_ControlIdInfo(kAnalogOut analog, kInfo* info);
124 
150 kFsFx(kStatus) kAnalogOut_SetCalibration(kAnalogOut analog, kArray2 calibration);
151 
163 kFsFx(kStatus) kAnalogOut_OutputInfo(kAnalogOut analog, kInfo64f* info);
164 
176 kFsFx(kStatus) kAnalogOut_NominalOutputInfo(kAnalogOut analog, kInfo64f* info);
177 
190 kFsFx(kStatus) kAnalogOut_EnqueueOutput(kAnalogOut analog, k64f current);
191 
200 kFsFx(kStatus) kAnalogOut_Stats(kAnalogOut analog, kAnalogOutStats* stats);
201 
202 #include <kFireSync/Client/kAnalogOut.x.h>
203 
204 #endif
kAnalogOut::kAnalogOut_EnqueueOutput
kStatus kAnalogOut_EnqueueOutput(kAnalogOut analog, k64f current)
Enqueues an analog output value, in milliamps.
kAnalogOut::kAnalogOut_NominalOutputInfo
kStatus kAnalogOut_NominalOutputInfo(kAnalogOut analog, kInfo64f *info)
Reports constraints for nominal output current.
kAnalogOut::kAnalogOut_ControlIdInfo
kStatus kAnalogOut_ControlIdInfo(kAnalogOut analog, kInfo *info)
Reports constraint and validity information for the ControlId setting.
kInfoBits
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kInfo64f
Represents constraint and validity information for a double setting.
Definition: kInfo.h:438
kNodeDef.h
Essential declarations related to FireSync nodes.
kAnalogOut::kAnalogOut_ControlInfo
kStatus kAnalogOut_ControlInfo(kAnalogOut analog, kInfoBits *info)
Reports constraint and validity information for the Control setting.
kAnalogOut::kAnalogOut_Id
kSize kAnalogOut_Id(kAnalogOut analog)
Gets the id of the output.
kAnalogOut::kAnalogOut_Clear
kStatus kAnalogOut_Clear(kAnalogOut analog)
Re-initializes settings.
kAnalogOut
Represents analog configuration.
kAnalogOut::kAnalogOut_SetControl
kStatus kAnalogOut_SetControl(kAnalogOut analog, kAnalogOutControl type)
Sets the control mode of the analog output.
kAnalogOut::kAnalogOut_ControlId
k32u kAnalogOut_ControlId(kAnalogOut analog)
Gets the control source id for an analog output.
kAnalogOutControl
Represents analog output control modes.
kAnalogOut::kAnalogOut_IsEnabled
kBool kAnalogOut_IsEnabled(kAnalogOut analog)
Reports whether the analog output is currently enabled.
kAnalogOut::kAnalogOut_OutputInfo
kStatus kAnalogOut_OutputInfo(kAnalogOut analog, kInfo64f *info)
Reports constraints for output current.
kAnalogOut::kAnalogOut_Stats
kStatus kAnalogOut_Stats(kAnalogOut analog, kAnalogOutStats *stats)
Retrieve statistics for this analog output module.
kAnalogOutStats
Represents analog output run-time statistics.
Definition: kNodeDef.h:1356
kAnalogOut::kAnalogOut_Control
kAnalogOutControl kAnalogOut_Control(kAnalogOut analog)
Reports the control mode of the analog output.
kAnalogOut::kAnalogOut_SetCalibration
kStatus kAnalogOut_SetCalibration(kAnalogOut analog, kArray2 calibration)
Sets (or clears) calibration information.
kAnalogOut::kAnalogOut_Enable
kStatus kAnalogOut_Enable(kAnalogOut analog, kBool enable)
Enables or disables the analog output.
kAnalogOut::kAnalogOut_SetControlId
kStatus kAnalogOut_SetControlId(kAnalogOut analog, k32u id)
Sets the control source id for an analog output.
kInfo
Represents constraint and validity information for a general setting.
Definition: kInfo.h:64