FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kDigitalOut.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_DIGITAL_OUT_H
9 #define K_FIRESYNC_DIGITAL_OUT_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kDigitalOut; --forward-declared in kFsDef.x.h
20 
28 kFsFx(kSize) kDigitalOut_Id(kDigitalOut digital);
29 
37 kFsFx(kStatus) kDigitalOut_Clear(kDigitalOut digital);
38 
50 kFsFx(kStatus) kDigitalOut_Enable(kDigitalOut digital, kBool enable);
51 
59 kFsFx(kBool) kDigitalOut_IsEnabled(kDigitalOut digital);
60 
72 kFsFx(kStatus) kDigitalOut_SetControl(kDigitalOut digital, kDigitalOutControl type);
73 
81 kFsFx(kDigitalOutControl) kDigitalOut_Control(kDigitalOut digital);
82 
91 kFsFx(kStatus) kDigitalOut_ControlInfo(kDigitalOut digital, kInfoBits* info);
92 
104 kFsFx(kStatus) kDigitalOut_SetControlId(kDigitalOut digital, k32u id);
105 
113 kFsFx(k32u) kDigitalOut_ControlId(kDigitalOut digital);
114 
123 kFsFx(kStatus) kDigitalOut_ControlIdInfo(kDigitalOut digital, kInfo* info);
124 
133 kFsFx(kStatus) kDigitalOut_SetPolarity(kDigitalOut digital, kBool isActiveHigh);
134 
142 kFsFx(kBool) kDigitalOut_Polarity(kDigitalOut digital);
143 
152 kFsFx(kStatus) kDigitalOut_PolarityInfo(kDigitalOut digital, kInfoBool* info);
153 
163 kFsFx(kStatus) kDigitalOut_SetDelay(kDigitalOut digital, k64u delay, kAdjust adjustment = kADJUST_NONE);
164 
172 kFsFx(k64u) kDigitalOut_Delay(kDigitalOut digital);
173 
182 kFsFx(kStatus) kDigitalOut_DelayInfo(kDigitalOut digital, kInfo64u* info);
183 
193 kFsFx(kStatus) kDigitalOut_SetExposure(kDigitalOut digital, k64u exposure, kAdjust adjustment = kADJUST_NONE);
194 
202 kFsFx(k64u) kDigitalOut_Exposure(kDigitalOut digital);
203 
212 kFsFx(kStatus) kDigitalOut_ExposureInfo(kDigitalOut digital, kInfo64u* info);
213 
223 kFsFx(kStatus) kDigitalOut_SetGap(kDigitalOut digital, k64u gap, kAdjust adjustment = kADJUST_NONE);
224 
232 kFsFx(k64u) kDigitalOut_Gap(kDigitalOut digital);
233 
242 kFsFx(kStatus) kDigitalOut_GapInfo(kDigitalOut digital, kInfo64u* info);
243 
253 kFsFx(k64u) kDigitalOut_MinimumPeriod(kDigitalOut digital);
254 
263 kFsFx(kStatus) kDigitalOut_SetState(kDigitalOut digital, kBool state);
264 
273 kFsFx(kStatus) kDigitalOut_Stats(kDigitalOut digital, kDigitalOutStats* stats);
274 
282 kFsFx(kStatus) kDigitalOut_Trigger(kDigitalOut digital);
283 
284 #include <kFireSync/Client/kDigitalOut.x.h>
285 
286 #endif
kDigitalOut::kDigitalOut_IsEnabled
kBool kDigitalOut_IsEnabled(kDigitalOut digital)
Reports whether the digital is currently enabled.
kDigitalOut::kDigitalOut_SetDelay
kStatus kDigitalOut_SetDelay(kDigitalOut digital, k64u delay, kAdjust adjustment=kADJUST_NONE)
Sets the delay for the digital, in nanoseconds.
kDigitalOut::kDigitalOut_SetControlId
kStatus kDigitalOut_SetControlId(kDigitalOut digital, k32u id)
Sets the control source id for a digital.
kDigitalOut::kDigitalOut_ControlId
k32u kDigitalOut_ControlId(kDigitalOut digital)
Gets the control source id for a digital.
kDigitalOut::kDigitalOut_GapInfo
kStatus kDigitalOut_GapInfo(kDigitalOut digital, kInfo64u *info)
Reports constraint and validity information for the Gap setting.
kDigitalOut
Represents digital configuration.
kDigitalOut::kDigitalOut_Gap
k64u kDigitalOut_Gap(kDigitalOut digital)
Gets the gap for the digital, in nanoseconds.
kInfoBits
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kAdjust
Type of adjustment to perform to bring a setting into conformance with its constraints.
kAdjust::kADJUST_NONE
#define kADJUST_NONE
No adjustment.
Definition: kInfo.h:48
kDigitalOut::kDigitalOut_Polarity
kBool kDigitalOut_Polarity(kDigitalOut digital)
Gets the polarity for a digital.
kNodeDef.h
Essential declarations related to FireSync nodes.
kDigitalOut::kDigitalOut_MinimumPeriod
k64u kDigitalOut_MinimumPeriod(kDigitalOut digital)
Reports the time required by this digital output to respond to an event.
kDigitalOut::kDigitalOut_Control
kDigitalOutControl kDigitalOut_Control(kDigitalOut digital)
Reports the control mode of the digital.
kDigitalOut::kDigitalOut_SetState
kStatus kDigitalOut_SetState(kDigitalOut digital, kBool state)
Sets the output state.
kDigitalOut::kDigitalOut_Trigger
kStatus kDigitalOut_Trigger(kDigitalOut digital)
Provides a software trigger to a digital output.
kDigitalOut::kDigitalOut_Id
kSize kDigitalOut_Id(kDigitalOut digital)
Gets the id of the output.
kDigitalOut::kDigitalOut_Delay
k64u kDigitalOut_Delay(kDigitalOut digital)
Gets the delay for the digital, in nanoseconds.
kDigitalOut::kDigitalOut_ControlInfo
kStatus kDigitalOut_ControlInfo(kDigitalOut digital, kInfoBits *info)
Reports constraint and validity information for the Control setting.
kDigitalOut::kDigitalOut_DelayInfo
kStatus kDigitalOut_DelayInfo(kDigitalOut digital, kInfo64u *info)
Reports constraint and validity information for the Delay setting.
kDigitalOut::kDigitalOut_Enable
kStatus kDigitalOut_Enable(kDigitalOut digital, kBool enable)
Enables or disables the digital.
kDigitalOutControl
Represents digital output control modes.
kInfo64u
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:234
kDigitalOut::kDigitalOut_PolarityInfo
kStatus kDigitalOut_PolarityInfo(kDigitalOut digital, kInfoBool *info)
Reports constraint and validity information for the Polarity setting.
kDigitalOut::kDigitalOut_SetExposure
kStatus kDigitalOut_SetExposure(kDigitalOut digital, k64u exposure, kAdjust adjustment=kADJUST_NONE)
Sets the exposure for the digital, in nanoseconds.
kDigitalOut::kDigitalOut_SetControl
kStatus kDigitalOut_SetControl(kDigitalOut digital, kDigitalOutControl type)
Sets the control mode of the digital.
kDigitalOut::kDigitalOut_Exposure
k64u kDigitalOut_Exposure(kDigitalOut digital)
Gets the exposure for the digital, in nanoseconds.
kDigitalOut::kDigitalOut_ExposureInfo
kStatus kDigitalOut_ExposureInfo(kDigitalOut digital, kInfo64u *info)
Reports constraint and validity information for the Exposure setting.
kDigitalOut::kDigitalOut_SetPolarity
kStatus kDigitalOut_SetPolarity(kDigitalOut digital, kBool isActiveHigh)
Sets the polarity for a digital.
kInfo
Represents constraint and validity information for a general setting.
Definition: kInfo.h:64
kDigitalOut::kDigitalOut_SetGap
kStatus kDigitalOut_SetGap(kDigitalOut digital, k64u gap, kAdjust adjustment=kADJUST_NONE)
Sets the gap for the digital, in nanoseconds.
kDigitalOut::kDigitalOut_Stats
kStatus kDigitalOut_Stats(kDigitalOut digital, kDigitalOutStats *stats)
Retrieve statistics.
kInfoBool
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:493
kDigitalOut::kDigitalOut_Clear
kStatus kDigitalOut_Clear(kDigitalOut digital)
Resets digital output mode settings to defaults.
kDigitalOut::kDigitalOut_ControlIdInfo
kStatus kDigitalOut_ControlIdInfo(kDigitalOut digital, kInfo *info)
Reports constraint and validity information for the ControlId setting.
kDigitalOutStats
Represents digital output run-time statistics.
Definition: kNodeDef.h:1304