Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoDigital Class Reference

Description

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...
 

Member Function Documentation

kStatus GoDigital_AddSource ( GoDigital  digital,
k32u  sourceId 
)

Selects the specified decision source for use in determining pass/fail status.

Parameters
digitalGoDigital object.
sourceIdIndex of the source to be added/selected.
Returns
Operation status.
kStatus GoDigital_ClearSources ( GoDigital  digital)

Removes all selected decision sources.

Parameters
digitalGoDigital object.
Returns
Operation status.
k64s GoDigital_Delay ( GoDigital  digital)

Gets the output delay.

Parameters
digitalGoDigital object.
Returns
The output delay (us or mm).
kStatus GoDigital_EnableSchedule ( GoDigital  digital,
kBool  enabled 
)

Enables or disables the scheduler for this output.

Parameters
digitalGoDigital object.
enabledkTRUE to enable, kFALSE to disable
Returns
Operation status.
GoDigitalEvent GoDigital_Event ( GoDigital  digital)

Gets the event which triggers this output to fire.

Parameters
digitalGoDigital object.
Returns
The output event.
k32u GoDigital_OptionAt ( GoDigital  digital,
k32u  index 
)

Gets the decision source option at the specified index.

Parameters
digitalGoDigital object.
indexSource option index.
Returns
Source option.
kSize GoDigital_OptionCount ( GoDigital  digital)

Gets the number of available decision source options.

Parameters
digitalGoDigital object.
Returns
Count of decision source options.
kArrayList GoDigital_OptionList ( GoDigital  digital)

Gets the list of source options for the specified output type.

Parameters
digitalGoDigital object.
Returns
An array list of source options.
GoDigitalPass GoDigital_PassMode ( GoDigital  digital)

Gets the pass/fail mode for the digital output.

Parameters
digitalGoDigital object.
Returns
Current pass/fail mode.
k32u GoDigital_PulseWidth ( GoDigital  digital)

Gets the width of digital output pulses.

Parameters
digitalGoDigital object.
Returns
Pulse width (microseconds).
k32u GoDigital_PulseWidthLimitMax ( GoDigital  digital)

Gets the maximum valid value for the PulseWidth setting.

Parameters
digitalGoDigital object.
Returns
Maximum valid pulse width value (microseconds).
k32u GoDigital_PulseWidthLimitMin ( GoDigital  digital)

Gets the minimum valid value for the PulseWidth setting.

Parameters
digitalGoDigital object.
Returns
Minimum valid pulse width value (microseconds).
kStatus GoDigital_RemoveSource ( GoDigital  digital,
k32u  index 
)

Removes (deselects) the decision source at the specified index.

Parameters
digitalGoDigital object.
indexIndex of the source to be removed.
Returns
Operation status.
kBool GoDigital_ScheduleEnabled ( GoDigital  digital)

Gets the enabled state of the scheduler for this output.

Parameters
digitalGoDigital object.
Returns
kTRUE if the scheduler is enabled.
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.

Parameters
digitalGoDigital object.
delayk64s object.
Returns
Operation status.
kStatus GoDigital_SetEvent ( GoDigital  digital,
GoDigitalEvent  event 
)

Sets the event which triggers this output to fire.

Parameters
digitalGoDigital object.
eventThe output event.
Returns
Operation status.
kStatus GoDigital_SetPassMode ( GoDigital  digital,
GoDigitalPass  pass 
)

Sets the pass/fail mode for the digital output.

Parameters
digitalGoDigital object.
passPass/fail mode.
Returns
Operation status.
kStatus GoDigital_SetPulseWidth ( GoDigital  digital,
k32u  width 
)

Sets the width of digital output pulses.

Parameters
digitalGoDigital object.
widthPulse width (microseconds).
Returns
Operation status.
kStatus GoDigital_SetSignalType ( GoDigital  digital,
GoDigitalSignal  signal 
)

Sets the signal type of output.

Parameters
digitalGoDigital object.
signalThe signal type.
Returns
Operation status.
GoDigitalSignal GoDigital_SignalType ( GoDigital  digital)

Gets the signal type of output.

Parameters
digitalGoDigital object.
Returns
The signal type.
k32u GoDigital_SourceAt ( GoDigital  digital,
k32u  index 
)

Gets the identifier of the selected output source at the specified index.

Parameters
digitalGoDigital object.
indexSelected source index.
Returns
Source identifier.
kSize GoDigital_SourceCount ( GoDigital  digital)

Gets the number of decision sources that are currently selected for determining pass/fail state.

Parameters
digitalGoDigital object.
Returns
Count of selected sources.

The documentation for this class was generated from the following file: