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 
13 kBeginHeader()
14 
15 
21 //typedef kObject kDigitalOut; --forward-declared in kFsDef.x.h
22 
23 
30 kFsFx(kSize) kDigitalOut_Id(kDigitalOut digital);
31 
39 kFsFx(kStatus) kDigitalOut_Clear(kDigitalOut digital);
40 
52 kFsFx(kStatus) kDigitalOut_Enable(kDigitalOut digital, kBool enable);
53 
62 
75 
84 
94 
107 
115 kFsFx(k32u) kDigitalOut_ControlId(kDigitalOut digital);
116 
125 kFsFx(kStatus) kDigitalOut_ControlIdInfo(kDigitalOut digital, kInfo* info);
126 
135 kFsFx(kStatus) kDigitalOut_SetPolarity(kDigitalOut digital, kBool isActiveHigh);
136 
144 kFsFx(kBool) kDigitalOut_Polarity(kDigitalOut digital);
145 
155 
164 kFsFx(kStatus) kDigitalOut_SetDelay(kDigitalOut digital, k64u delay);
165 
173 kFsFx(k64u) kDigitalOut_Delay(kDigitalOut digital);
174 
183 kFsFx(kStatus) kDigitalOut_DelayInfo(kDigitalOut digital, kInfo64u* info);
184 
193 kFsFx(kStatus) kDigitalOut_SetExposure(kDigitalOut digital, k64u exposure);
194 
202 kFsFx(k64u) kDigitalOut_Exposure(kDigitalOut digital);
203 
213 
222 kFsFx(kStatus) kDigitalOut_SetGap(kDigitalOut digital, k64u gap);
223 
231 kFsFx(k64u) kDigitalOut_Gap(kDigitalOut digital);
232 
241 kFsFx(kStatus) kDigitalOut_GapInfo(kDigitalOut digital, kInfo64u* info);
242 
253 
262 kFsFx(kStatus) kDigitalOut_SetState(kDigitalOut digital, kBool state);
263 
272 kFsFx(kStatus) kDigitalOut_Stats(kDigitalOut digital, kDigitalOutStats* stats);
273 
281 kFsFx(kStatus) kDigitalOut_Trigger(kDigitalOut digital);
282 
283 kEndHeader()
284 
285 #include <kFireSync/Client/kDigitalOut.x.h>
286 
287 #endif
kBool kDigitalOut_IsEnabled(kDigitalOut digital)
Reports whether the digital is currently enabled.
kStatus kDigitalOut_SetControlId(kDigitalOut digital, k32u id)
Sets the control source id for a digital.
k32u kDigitalOut_ControlId(kDigitalOut digital)
Gets the control source id for a digital.
kStatus kDigitalOut_GapInfo(kDigitalOut digital, kInfo64u *info)
Reports constraint and validity information for the Gap setting.
kStatus kDigitalOut_SetExposure(kDigitalOut digital, k64u exposure)
Sets the exposure for the digital, in nanoseconds.
Represents digital configuration.
k64u kDigitalOut_Gap(kDigitalOut digital)
Gets the gap for the digital, in nanoseconds.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:454
kBool kDigitalOut_Polarity(kDigitalOut digital)
Gets the polarity for a digital.
Essential declarations related to FireSync nodes.
kStatus kDigitalOut_SetDelay(kDigitalOut digital, k64u delay)
Sets the delay for the digital, in nanoseconds.
k64u kDigitalOut_MinimumPeriod(kDigitalOut digital)
Reports the time required by this digital output to respond to an event.
kDigitalOutControl kDigitalOut_Control(kDigitalOut digital)
Reports the control mode of the digital.
kStatus kDigitalOut_SetState(kDigitalOut digital, kBool state)
Sets the output state.
kStatus kDigitalOut_Trigger(kDigitalOut digital)
Provides a software trigger to a digital output.
kSize kDigitalOut_Id(kDigitalOut digital)
Gets the id of the output.
k64u kDigitalOut_Delay(kDigitalOut digital)
Gets the delay for the digital, in nanoseconds.
kStatus kDigitalOut_ControlInfo(kDigitalOut digital, kInfoBits *info)
Reports constraint and validity information for the Control setting.
kStatus kDigitalOut_DelayInfo(kDigitalOut digital, kInfo64u *info)
Reports constraint and validity information for the Delay setting.
kStatus kDigitalOut_Enable(kDigitalOut digital, kBool enable)
Enables or disables the digital.
Represents digital output control modes.
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:187
kStatus kDigitalOut_PolarityInfo(kDigitalOut digital, kInfoBool *info)
Reports constraint and validity information for the Polarity setting.
kStatus kDigitalOut_SetGap(kDigitalOut digital, k64u gap)
Sets the gap for the digital, in nanoseconds.
kStatus kDigitalOut_SetControl(kDigitalOut digital, kDigitalOutControl type)
Sets the control mode of the digital.
k64u kDigitalOut_Exposure(kDigitalOut digital)
Gets the exposure for the digital, in nanoseconds.
kStatus kDigitalOut_ExposureInfo(kDigitalOut digital, kInfo64u *info)
Reports constraint and validity information for the Exposure setting.
kStatus kDigitalOut_SetPolarity(kDigitalOut digital, kBool isActiveHigh)
Sets the polarity for a digital.
Represents constraint and validity information for a general setting.
Definition: kInfo.h:45
kStatus kDigitalOut_Stats(kDigitalOut digital, kDigitalOutStats *stats)
Retrieve statistics.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:403
kStatus kDigitalOut_Clear(kDigitalOut digital)
Resets digital output mode settings to defaults.
kStatus kDigitalOut_ControlIdInfo(kDigitalOut digital, kInfo *info)
Reports constraint and validity information for the ControlId setting.
Represents digital output run-time statistics.
Definition: kNodeDef.h:1078