Gocator API
|
Represents Digital output settings.
Inherits kObject.
Public Member Functions | |
kStatus | GoDigital_AddSource (GoDigital digital, k32u sourceId) |
Selects the specified decision source for use in determining pass/fail status. More... | |
kStatus | GoDigital_ClearSources (GoDigital digital) |
Removes all selected decision sources. More... | |
k64s | GoDigital_Delay (GoDigital digital) |
Gets the output delay. More... | |
kStatus | GoDigital_EnableSchedule (GoDigital digital, kBool enabled) |
Enables or disables the scheduler for this output. More... | |
GoDigitalEvent | GoDigital_Event (GoDigital digital) |
Gets the event which triggers this output to fire. More... | |
k32u | GoDigital_OptionAt (GoDigital digital, k32u index) |
Gets the decision source option at the specified index. More... | |
kSize | GoDigital_OptionCount (GoDigital digital) |
Gets the number of available decision source options. More... | |
kArrayList | GoDigital_OptionList (GoDigital digital) |
Gets the list of source options for the specified output type. More... | |
GoDigitalPass | GoDigital_PassMode (GoDigital digital) |
Gets the pass/fail mode for the digital output. More... | |
k32u | GoDigital_PulseWidth (GoDigital digital) |
Gets the width of digital output pulses. More... | |
k32u | GoDigital_PulseWidthLimitMax (GoDigital digital) |
Gets the maximum valid value for the PulseWidth setting. More... | |
k32u | GoDigital_PulseWidthLimitMin (GoDigital digital) |
Gets the minimum valid value for the PulseWidth setting. More... | |
kStatus | GoDigital_RemoveSource (GoDigital digital, k32u index) |
Removes (deselects) the decision source at the specified index. More... | |
kBool | GoDigital_ScheduleEnabled (GoDigital digital) |
Gets the enabled state of the scheduler for this output. More... | |
kStatus | GoDigital_SetDelay (GoDigital digital, k64s delay) |
Sets the delay from exposure until output is triggered, in units based on GoDomain. More... | |
kStatus | GoDigital_SetEvent (GoDigital digital, GoDigitalEvent event) |
Sets the event which triggers this output to fire. More... | |
kStatus | GoDigital_SetPassMode (GoDigital digital, GoDigitalPass pass) |
Sets the pass/fail mode for the digital output. More... | |
kStatus | GoDigital_SetPulseWidth (GoDigital digital, k32u width) |
Sets the width of digital output pulses. More... | |
kStatus | GoDigital_SetSignalType (GoDigital digital, GoDigitalSignal signal) |
Sets the signal type of output. More... | |
GoDigitalSignal | GoDigital_SignalType (GoDigital digital) |
Gets the signal type of output. More... | |
k32u | GoDigital_SourceAt (GoDigital digital, k32u index) |
Gets the identifier of the selected output source at the specified index. More... | |
kSize | GoDigital_SourceCount (GoDigital digital) |
Gets the number of decision sources that are currently selected for determining pass/fail state. More... | |
kStatus GoDigital_AddSource | ( | GoDigital | digital, |
k32u | sourceId | ||
) |
Selects the specified decision source for use in determining pass/fail status.
digital | GoDigital object. |
sourceId | Index of the source to be added/selected. |
kStatus GoDigital_ClearSources | ( | GoDigital | digital | ) |
k64s GoDigital_Delay | ( | GoDigital | digital | ) |
kStatus GoDigital_EnableSchedule | ( | GoDigital | digital, |
kBool | enabled | ||
) |
Enables or disables the scheduler for this output.
digital | GoDigital object. |
enabled | kTRUE to enable, kFALSE to disable |
GoDigitalEvent GoDigital_Event | ( | GoDigital | digital | ) |
Gets the event which triggers this output to fire.
digital | GoDigital object. |
k32u GoDigital_OptionAt | ( | GoDigital | digital, |
k32u | index | ||
) |
Gets the decision source option at the specified index.
digital | GoDigital object. |
index | Source option index. |
kSize GoDigital_OptionCount | ( | GoDigital | digital | ) |
Gets the number of available decision source options.
digital | GoDigital object. |
kArrayList GoDigital_OptionList | ( | GoDigital | digital | ) |
Gets the list of source options for the specified output type.
digital | GoDigital object. |
GoDigitalPass GoDigital_PassMode | ( | GoDigital | digital | ) |
Gets the pass/fail mode for the digital output.
digital | GoDigital object. |
k32u GoDigital_PulseWidth | ( | GoDigital | digital | ) |
Gets the width of digital output pulses.
digital | GoDigital object. |
k32u GoDigital_PulseWidthLimitMax | ( | GoDigital | digital | ) |
Gets the maximum valid value for the PulseWidth setting.
digital | GoDigital object. |
k32u GoDigital_PulseWidthLimitMin | ( | GoDigital | digital | ) |
Gets the minimum valid value for the PulseWidth setting.
digital | GoDigital object. |
kStatus GoDigital_RemoveSource | ( | GoDigital | digital, |
k32u | index | ||
) |
Removes (deselects) the decision source at the specified index.
digital | GoDigital object. |
index | Index of the source to be removed. |
kBool GoDigital_ScheduleEnabled | ( | GoDigital | digital | ) |
Gets the enabled state of the scheduler for this output.
digital | GoDigital object. |
kStatus GoDigital_SetDelay | ( | GoDigital | digital, |
k64s | delay | ||
) |
Sets the delay from exposure until output is triggered, in units based on GoDomain.
mm units when GoDomain is distance, uS units when GoDomain is time. Ignored when GoDomain is Immediate or when PassMode is Software.
digital | GoDigital object. |
delay | k64s object. |
kStatus GoDigital_SetEvent | ( | GoDigital | digital, |
GoDigitalEvent | event | ||
) |
Sets the event which triggers this output to fire.
digital | GoDigital object. |
event | The output event. |
kStatus GoDigital_SetPassMode | ( | GoDigital | digital, |
GoDigitalPass | pass | ||
) |
Sets the pass/fail mode for the digital output.
digital | GoDigital object. |
pass | Pass/fail mode. |
kStatus GoDigital_SetPulseWidth | ( | GoDigital | digital, |
k32u | width | ||
) |
Sets the width of digital output pulses.
digital | GoDigital object. |
width | Pulse width (microseconds). |
kStatus GoDigital_SetSignalType | ( | GoDigital | digital, |
GoDigitalSignal | signal | ||
) |
Sets the signal type of output.
digital | GoDigital object. |
signal | The signal type. |
GoDigitalSignal GoDigital_SignalType | ( | GoDigital | digital | ) |
k32u GoDigital_SourceAt | ( | GoDigital | digital, |
k32u | index | ||
) |
Gets the identifier of the selected output source at the specified index.
digital | GoDigital object. |
index | Selected source index. |
kSize GoDigital_SourceCount | ( | GoDigital | digital | ) |
Gets the number of decision sources that are currently selected for determining pass/fail state.
digital | GoDigital object. |