Gocator API
|
Represents Analog output settings.
Inherits kObject.
Public Member Functions | |
kStatus | GoAnalog_ClearSource (GoAnalog analog) |
Clears the currently selected source identifier. More... | |
k64f | GoAnalog_CurrentInvalid (GoAnalog analog) |
Gets the current output level associated with an invalid measurement. More... | |
kBool | GoAnalog_CurrentInvalidEnabled (GoAnalog analog) |
Gets the status of the invalid current enabled option. More... | |
k64f | GoAnalog_CurrentLimitMax (GoAnalog analog) |
Gets the maximum valid value for CurrentMin, CurrentMax and CurrentInvalid settings. More... | |
k64f | GoAnalog_CurrentLimitMin (GoAnalog analog) |
Gets the minimum valid value for CurrentMin, CurrentMax and CurrentInvalid settings. More... | |
k64f | GoAnalog_CurrentMax (GoAnalog analog) |
Gets the maximum current output level. More... | |
k64f | GoAnalog_CurrentMin (GoAnalog analog) |
Gets the minimum current output level. More... | |
k64f | GoAnalog_DataScaleMax (GoAnalog analog) |
Gets the measurement value associated with the maximum output current value. More... | |
k64f | GoAnalog_DataScaleMin (GoAnalog analog) |
Gets the measurement value associated with the minimum output current value. More... | |
k64s | GoAnalog_Delay (GoAnalog analog) |
Gets the output delay. More... | |
kStatus | GoAnalog_EnableCurrentInvalid (GoAnalog analog, kBool enable) |
Enables the current output level associated with an invalid measurement. More... | |
kStatus | GoAnalog_EnableSchedule (GoAnalog analog, kBool enabled) |
Enables or disables the scheduler for this output. More... | |
GoAnalogEvent | GoAnalog_Event (GoAnalog analog) |
Gets the event which triggers this output to fire. More... | |
k32u | GoAnalog_OptionAt (GoAnalog analog, GoOutputSource type, k32u index) |
Gets the source option at the specified index. More... | |
kSize | GoAnalog_OptionCount (GoAnalog analog) |
Gets the number of source options for the specified output type. More... | |
kArrayList | GoAnalog_OptionList (GoAnalog analog) |
Gets the list of source options for the specified output type. More... | |
kBool | GoAnalog_ScheduleEnabled (GoAnalog analog) |
Gets the enabled state of the scheduler for this output. More... | |
kStatus | GoAnalog_SetCurrentInvalid (GoAnalog analog, k64f invalid) |
Sets the current output level associated with an invalid measurement. More... | |
kStatus | GoAnalog_SetCurrentMax (GoAnalog analog, k64f max) |
Sets the maximum current output level. More... | |
kStatus | GoAnalog_SetCurrentMin (GoAnalog analog, k64f min) |
Sets the minimum current output level. More... | |
kStatus | GoAnalog_SetDataScaleMax (GoAnalog analog, k64f max) |
Sets the measurement value associated with the maximum output current value. More... | |
kStatus | GoAnalog_SetDataScaleMin (GoAnalog analog, k64f min) |
Sets the measurement value associated with the minimum output current value. More... | |
kStatus | GoAnalog_SetDelay (GoAnalog analog, k64s delay) |
Sets the delay from exposure until output is triggered, in units based on GoDomain mm when GoDomain is distance, uS when GoDomain is time. More... | |
kStatus | GoAnalog_SetEvent (GoAnalog analog, GoAnalogEvent event) |
Set the event which triggers this output to fire. More... | |
kStatus | GoAnalog_SetSource (GoAnalog analog, k32u sourceId) |
Selects a source type and source identifier for output. More... | |
k32u | GoAnalog_Source (GoAnalog analog) |
Gets the selected source identifier. More... | |
kStatus GoAnalog_ClearSource | ( | GoAnalog | analog | ) |
Clears the currently selected source identifier.
analog | GoAnalog object. |
k64f GoAnalog_CurrentInvalid | ( | GoAnalog | analog | ) |
Gets the current output level associated with an invalid measurement.
analog | GoAnalog object. |
kBool GoAnalog_CurrentInvalidEnabled | ( | GoAnalog | analog | ) |
Gets the status of the invalid current enabled option.
analog | GoAnalog object. |
k64f GoAnalog_CurrentLimitMax | ( | GoAnalog | analog | ) |
Gets the maximum valid value for CurrentMin, CurrentMax and CurrentInvalid settings.
analog | GoAnalog object. |
k64f GoAnalog_CurrentLimitMin | ( | GoAnalog | analog | ) |
Gets the minimum valid value for CurrentMin, CurrentMax and CurrentInvalid settings.
analog | GoAnalog object. |
k64f GoAnalog_CurrentMax | ( | GoAnalog | analog | ) |
Gets the maximum current output level.
analog | GoAnalog object. |
k64f GoAnalog_CurrentMin | ( | GoAnalog | analog | ) |
Gets the minimum current output level.
analog | GoAnalog object. |
k64f GoAnalog_DataScaleMax | ( | GoAnalog | analog | ) |
Gets the measurement value associated with the maximum output current value.
analog | GoAnalog object. |
k64f GoAnalog_DataScaleMin | ( | GoAnalog | analog | ) |
Gets the measurement value associated with the minimum output current value.
analog | GoAnalog object. |
k64s GoAnalog_Delay | ( | GoAnalog | analog | ) |
kStatus GoAnalog_EnableCurrentInvalid | ( | GoAnalog | analog, |
kBool | enable | ||
) |
Enables the current output level associated with an invalid measurement.
When this is disabled, the output value will be held constant on an invalid measurement
analog | GoAnalog object. |
enable | kTRUE to enable, or kFALSE to disable. |
kStatus GoAnalog_EnableSchedule | ( | GoAnalog | analog, |
kBool | enabled | ||
) |
Enables or disables the scheduler for this output.
analog | GoAnalog object. |
enabled | kTRUE to enable, kFALSE to disable |
GoAnalogEvent GoAnalog_Event | ( | GoAnalog | analog | ) |
Gets the event which triggers this output to fire.
analog | GoAnalog object. |
k32u GoAnalog_OptionAt | ( | GoAnalog | analog, |
GoOutputSource | type, | ||
k32u | index | ||
) |
Gets the source option at the specified index.
analog | GoAnalog object. |
type | Output source type (value or decision). |
index | Source option index. |
kSize GoAnalog_OptionCount | ( | GoAnalog | analog | ) |
Gets the number of source options for the specified output type.
analog | GoAnalog object. |
type | Output source type (value or decision). |
kArrayList GoAnalog_OptionList | ( | GoAnalog | analog | ) |
Gets the list of source options for the specified output type.
analog | GoAnalog object. |
kBool GoAnalog_ScheduleEnabled | ( | GoAnalog | analog | ) |
Gets the enabled state of the scheduler for this output.
analog | GoAnalog object. |
kStatus GoAnalog_SetCurrentInvalid | ( | GoAnalog | analog, |
k64f | invalid | ||
) |
Sets the current output level associated with an invalid measurement.
analog | GoAnalog object. |
invalid | Invalid output current (mA). |
kStatus GoAnalog_SetCurrentMax | ( | GoAnalog | analog, |
k64f | max | ||
) |
Sets the maximum current output level.
analog | GoAnalog object. |
max | Maximum current output level (mA). |
kStatus GoAnalog_SetCurrentMin | ( | GoAnalog | analog, |
k64f | min | ||
) |
Sets the minimum current output level.
analog | GoAnalog object. |
min | Minimum current output level (mA). |
kStatus GoAnalog_SetDataScaleMax | ( | GoAnalog | analog, |
k64f | max | ||
) |
Sets the measurement value associated with the maximum output current value.
analog | GoAnalog object. |
max | Maximum measurement value (units are measurement dependent). |
kStatus GoAnalog_SetDataScaleMin | ( | GoAnalog | analog, |
k64f | min | ||
) |
Sets the measurement value associated with the minimum output current value.
analog | GoAnalog object. |
min | Minimum measurement value (units are measurement dependent). |
kStatus GoAnalog_SetDelay | ( | GoAnalog | analog, |
k64s | delay | ||
) |
Sets the delay from exposure until output is triggered, in units based on GoDomain mm when GoDomain is distance, uS when GoDomain is time.
The delay is ignored when GoDomain is Immediate or when output is Software triggered.
analog | GoAnalog object. |
delay | The delay (uS or mm) |
kStatus GoAnalog_SetEvent | ( | GoAnalog | analog, |
GoAnalogEvent | event | ||
) |
Set the event which triggers this output to fire.
analog | GoAnalog object. |
event | The selected output event. |
kStatus GoAnalog_SetSource | ( | GoAnalog | analog, |
k32u | sourceId | ||
) |
Selects a source type and source identifier for output.
analog | GoAnalog object. |
sourceId | Output source identifier. |
k32u GoAnalog_Source | ( | GoAnalog | analog | ) |
Gets the selected source identifier.
analog | GoAnalog object. |