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

Description

Represents a ...

Inherits kObject.

Public Member Functions

k64f GoSetup_ActiveAreaHeight (GoSetup setup, GoRole role)
 Gets the active area height. More...
 
k64f GoSetup_ActiveAreaHeightLimitMax (GoSetup setup, GoRole role)
 Gets the maximum valid value for the ActiveAreaHeight setting. More...
 
k64f GoSetup_ActiveAreaHeightLimitMin (GoSetup setup, GoRole role)
 Gets the minimum valid value for the ActiveAreaHeight setting. More...
 
k64f GoSetup_ActiveAreaLength (GoSetup setup, GoRole role)
 Gets the active area Length. More...
 
k64f GoSetup_ActiveAreaLengthLimitMax (GoSetup setup, GoRole role)
 Gets the maximum valid value for the ActiveAreaLength setting. More...
 
k64f GoSetup_ActiveAreaLengthLimitMin (GoSetup setup, GoRole role)
 Gets the minimum valid value for the ActiveAreaLength setting. More...
 
k64f GoSetup_ActiveAreaWidth (GoSetup setup, GoRole role)
 Gets the active area width. More...
 
k64f GoSetup_ActiveAreaWidthLimitMax (GoSetup setup, GoRole role)
 Gets the maximum valid value for the ActiveAreaWidth setting. More...
 
k64f GoSetup_ActiveAreaWidthLimitMin (GoSetup setup, GoRole role)
 Gets the minimum valid value for the ActiveAreaWidth setting. More...
 
k64f GoSetup_ActiveAreaX (GoSetup setup, GoRole role)
 Gets the active area x origin. More...
 
k64f GoSetup_ActiveAreaXLimitMax (GoSetup setup, GoRole role)
 Gets the maximum valid value for the ActiveAreaX setting. More...
 
k64f GoSetup_ActiveAreaXLimitMin (GoSetup setup, GoRole role)
 Gets the minimum valid value for the ActiveAreaX setting. More...
 
k64f GoSetup_ActiveAreaY (GoSetup setup, GoRole role)
 Gets the active area Y. More...
 
k64f GoSetup_ActiveAreaYLimitMax (GoSetup setup, GoRole role)
 Gets the maximum valid value for the ActiveAreaY setting. More...
 
k64f GoSetup_ActiveAreaYLimitMin (GoSetup setup, GoRole role)
 Gets the minimum valid value for the ActiveAreaY setting. More...
 
k64f GoSetup_ActiveAreaZ (GoSetup setup, GoRole role)
 Gets the active area z origin. More...
 
k64f GoSetup_ActiveAreaZLimitMax (GoSetup setup, GoRole role)
 Gets the maximum valid value for the ActiveAreaZ setting. More...
 
k64f GoSetup_ActiveAreaZLimitMin (GoSetup setup, GoRole role)
 Gets the minimum valid value for the ActiveAreaZ setting. More...
 
kStatus GoSetup_AddExposureStep (GoSetup setup, GoRole role, k64f exposure)
 Adds an exposure step. More...
 
kBool GoSetup_AlignmentEncoderCalibrateEnabled (GoSetup setup)
 Gets the value of the post alignment encoder calibration setting. More...
 
GoAlignmentTarget GoSetup_AlignmentStationaryTarget (GoSetup setup)
 Gets the target type used for alignment calibration. More...
 
GoAlignmentType GoSetup_AlignmentType (GoSetup setup)
 Gets the type used for alignment calibration. More...
 
k64f GoSetup_BarHeight (GoSetup setup)
 Gets the height of the bar used for travel calibration. More...
 
kSize GoSetup_BarHoleCount (GoSetup setup)
 Gets the number of holes that are defined on the calibration bar. More...
 
k64f GoSetup_BarHoleDiameter (GoSetup setup)
 Gets the diameter of holes that are defined on the calibration bar. More...
 
k64f GoSetup_BarHoleDistance (GoSetup setup)
 Gets the distance between holes that are defined on the calibration bar. More...
 
k64f GoSetup_BarWidth (GoSetup setup)
 Gets the width of the bar used for travel calibration. More...
 
kStatus GoSetup_ClearExposureSteps (GoSetup setup, GoRole role)
 Removes all exposure steps. More...
 
GoState GoSetup_DefaultState (GoSetup setup)
 Gets the default state of the sensor system upon boot. More...
 
k64f GoSetup_DiskDiameter (GoSetup setup)
 Gets the diameter of the disk used for travel calibration. More...
 
k64f GoSetup_DiskHeight (GoSetup setup)
 Gets the height of the disk used for travel calibration. More...
 
k64f GoSetup_DynamicExposureMax (GoSetup setup, GoRole role)
 Gets the maximum value for the Dynamic Exposure setting. More...
 
k64f GoSetup_DynamicExposureMin (GoSetup setup, GoRole role)
 Gets the minimum value for the Dynamic Exposure setting. More...
 
kStatus GoSetup_EnableAlignmentEncoderCalibrate (GoSetup setup, kBool enabled)
 Enables encoder calibration after alignment. More...
 
kStatus GoSetup_EnableIntensity (GoSetup setup, kBool enable)
 Enables profile intensity collection. More...
 
kStatus GoSetup_EnableMaxFrameRate (GoSetup setup, kBool enable)
 Enables or disables operation at full frame rate (ignoring frame rate setting). More...
 
kStatus GoSetup_EnableTracking (GoSetup setup, GoRole role, kBool enable)
 Enables tracking. More...
 
kStatus GoSetup_EnableTriggerGate (GoSetup setup, kBool enable)
 Sets the trigger gate feature. More...
 
kStatus GoSetup_EnableXGapFilling (GoSetup setup, kBool enable)
 Sets the status of x-direction gap-filling. More...
 
kStatus GoSetup_EnableXSmoothing (GoSetup setup, kBool enabled)
 Sets the status of x-direction smoothing. More...
 
kStatus GoSetup_EnableYGapFilling (GoSetup setup, kBool enable)
 Sets the status of y-direction gap-filling. More...
 
kStatus GoSetup_EnableYSmoothing (GoSetup setup, kBool enable)
 Sets the status of y-direction smoothing. More...
 
k64f GoSetup_EncoderSpacing (GoSetup setup)
 Gets the current encoder period for encoder-based triggering. More...
 
k64f GoSetup_EncoderSpacingLimitMax (GoSetup setup)
 Constraint for the maximum valid value of the EncoderPeriod setting. More...
 
k64f GoSetup_EncoderSpacingLimitMin (GoSetup setup)
 Constraint for the minimum valid value of the EncoderPeriod setting. More...
 
GoEncoderTriggerMode GoSetup_EncoderTriggerMode (GoSetup setup)
 Gets the encoder trigger mode. More...
 
k64f GoSetup_Exposure (GoSetup setup, GoRole role)
 Gets the exposure value. More...
 
k32u GoSetup_ExposureDelay (GoSetup setup, GoRole role)
 Gets the exposure delay. More...
 
k64f GoSetup_ExposureLimitMax (GoSetup setup, GoRole role)
 Gets the maximum valid value for the Exposure setting. More...
 
k64f GoSetup_ExposureLimitMin (GoSetup setup, GoRole role)
 Gets the minimum valid value for the Exposure setting. More...
 
GoExposureMode GoSetup_ExposureMode (GoSetup setup, GoRole role)
 Gets the exposure mode. More...
 
k64f GoSetup_ExposureStepAt (GoSetup setup, GoRole role, k32u index)
 Get the exposure step value specified by index. More...
 
kSize GoSetup_ExposureStepCount (GoSetup setup, GoRole role)
 Get the number of exposure steps defined. More...
 
k64f GoSetup_FrameRate (GoSetup setup)
 Reports the currently configured frame rate. More...
 
k64f GoSetup_FrameRateLimitMax (GoSetup setup)
 Constraint for the maximum valid value of the Frame Rate setting. More...
 
k64f GoSetup_FrameRateLimitMin (GoSetup setup)
 Constraint for the minimum valid value of the Frame Rate setting. More...
 
k32u GoSetup_FrontCameraHeight (GoSetup setup, GoRole role)
 Gets the camera region-of-interest height. More...
 
k32u GoSetup_FrontCameraWidth (GoSetup setup, GoRole role)
 Gets the camera region-of-interest width. More...
 
k32u GoSetup_FrontCameraX (GoSetup setup, GoRole role)
 Gets the camera region-of-interest x origin. More...
 
k32u GoSetup_FrontCameraY (GoSetup setup, GoRole role)
 Gets the camera region-of-interest y origin. More...
 
kBool GoSetup_IntensityEnabled (GoSetup setup)
 Reports whether the profile intensity collection is enabled. More...
 
GoLayout GoSetup_Layout (GoSetup setup)
 Gets the layout configuration module. More...
 
kBool GoSetup_MaxFrameRateEnabled (GoSetup setup)
 Reports whether or not system is configured to operate at full frame rate. More...
 
GoOrientation GoSetup_Orientation (GoSetup setup)
 Gets the transform orientation identifier. More...
 
GoPartDetection GoSetup_PartDetection (GoSetup setup)
 Gets the part detection module, used for part detection configuration. More...
 
k64f GoSetup_PlateHeight (GoSetup setup)
 Gets the height of the plate used for travel calibration. More...
 
kSize GoSetup_PlateHoleCount (GoSetup setup)
 Gets the number of holes that are defined on the calibration plate. More...
 
k64f GoSetup_PlateRefHoleDiameter (GoSetup setup)
 Gets the diameter of the reference hole defined on the calibration plate. More...
 
k64f GoSetup_PlateSecHoleDiameter (GoSetup setup)
 Gets the diameter of the secondary hole defined on the calibration plate. More...
 
GoMode GoSetup_ScanMode (GoSetup setup)
 Gets the default operation mode of the sensor system. More...
 
kStatus GoSetup_SetActiveAreaHeight (GoSetup setup, GoRole role, k64f height)
 Sets the active area height. More...
 
k64f GoSetup_SetActiveAreaLength (GoSetup setup, GoRole role, k64f Length)
 Sets the active area Length. More...
 
k64f GoSetup_SetActiveAreaWidth (GoSetup setup, GoRole role, k64f width)
 Sets the active area width. More...
 
k64f GoSetup_SetActiveAreaX (GoSetup setup, GoRole role, k64f x)
 Sets the active area x origin. More...
 
k64f GoSetup_SetActiveAreaY (GoSetup setup, GoRole role, k64f Y)
 Sets the active area Y. More...
 
k64f GoSetup_SetActiveAreaZ (GoSetup setup, GoRole role, k64f z)
 Sets the active area z origin. More...
 
kStatus GoSetup_SetAlignmentStationaryTarget (GoSetup setup, GoAlignmentTarget target)
 Sets the target type used for alignment calibration. More...
 
kStatus GoSetup_SetAlignmentType (GoSetup setup, GoAlignmentType Type)
 Sets the type used for alignment. More...
 
kStatus GoSetup_SetBarHeight (GoSetup setup, k64f height)
 Sets the height of the bar used for travel calibration. More...
 
kStatus GoSetup_SetBarHoleCount (GoSetup setup, kSize count)
 Sets the number of holes that are defined on the calibration bar. More...
 
kStatus GoSetup_SetBarHoleDiameter (GoSetup setup, k64f diameter)
 Sets the diameter of holes that are defined on the calibration bar. More...
 
kStatus GoSetup_SetBarHoleDistance (GoSetup setup, k64f distance)
 Sets the distance between holes that are defined on the calibration bar. More...
 
kStatus GoSetup_SetBarWidth (GoSetup setup, k64f width)
 Sets the width of the bar used for travel calibration. More...
 
kStatus GoSetup_SetDefaultState (GoSetup setup, GoState state)
 Sets the default state of the sensor system upon boot. More...
 
kStatus GoSetup_SetDiskDiameter (GoSetup setup, k64f diameter)
 Sets the diameter of the disk used for travel calibration. More...
 
kStatus GoSetup_SetDiskHeight (GoSetup setup, k64f height)
 Sets the height of the disk used for travel calibration. More...
 
kStatus GoSetup_SetDynamicExposureMax (GoSetup setup, GoRole role, k64f exposure)
 Sets the maximum value for the Dynamic Exposure setting. More...
 
kStatus GoSetup_SetDynamicExposureMin (GoSetup setup, GoRole role, k64f exposure)
 Sets the minimum value for the Dynamic Exposure setting. More...
 
kStatus GoSetup_SetEncoderSpacing (GoSetup setup, k64f period)
 Sets the current encoder period for encoder-based triggering. More...
 
kStatus GoSetup_SetEncoderTriggerMode (GoSetup setup, GoEncoderTriggerMode mode)
 Sets the encoder trigger mode. More...
 
kStatus GoSetup_SetExposure (GoSetup setup, GoRole role, k64f exposure)
 Sets the exposure value. More...
 
kStatus GoSetup_SetExposureDelay (GoSetup setup, GoRole role, k32u delay)
 Sets the exposure delay. More...
 
kStatus GoSetup_SetExposureMode (GoSetup setup, GoRole role, GoExposureMode mode)
 Sets the exposure mode. More...
 
kStatus GoSetup_SetFrameRate (GoSetup setup, k64f frameRate)
 Sets the current frame rate for time-based triggering. More...
 
kStatus GoSetup_SetOrientation (GoSetup setup, GoOrientation orientation)
 Sets the transform x-offset. More...
 
kStatus GoSetup_SetPlateHeight (GoSetup setup, k64f height)
 Sets the height of the plate used for travel calibration. More...
 
kStatus GoSetup_SetPlateHoleCount (GoSetup setup, kSize count)
 Sets the number of holes that are defined on the calibration plate. More...
 
kStatus GoSetup_SetPlateRefHoleDiameter (GoSetup setup, k64f diameter)
 Sets the diameter of the reference hole defined on the calibration plate. More...
 
kStatus GoSetup_SetPlateSecHoleDiameter (GoSetup setup, k64f diameter)
 Sets the diameter of the secondary hole defined on the calibration plate. More...
 
kStatus GoSetup_SetScanMode (GoSetup setup, GoMode mode)
 Sets the default operation mode of the sensor system. More...
 
kStatus GoSetup_SetTrackingAreaHeight (GoSetup setup, GoRole role, k64f height)
 Sets the tracking window height. More...
 
kStatus GoSetup_SetTrackingSearchThreshold (GoSetup setup, GoRole role, k64f threshold)
 Sets the tracking window search threshold. More...
 
kStatus GoSetup_SetTriggerDelay (GoSetup setup, k64f delay)
 Sets the trigger delay. More...
 
kStatus GoSetup_SetTriggerSource (GoSetup setup, GoTrigger source)
 Sets the trigger source for profile triggering. More...
 
kStatus GoSetup_SetTriggerUnit (GoSetup setup, GoTriggerUnits unit)
 Sets the system trigger units. More...
 
kStatus GoSetup_SetXGapFillingWindow (GoSetup setup, k64f window)
 Sets the status of x-direction gap-filling. More...
 
kStatus GoSetup_SetXSmoothingWindow (GoSetup setup, k64f window)
 Sets the x-direction smoothing window. More...
 
kStatus GoSetup_SetXSubsampling (GoSetup setup, GoRole role, k32u xSubsampling)
 Sets the current x-resolution divider. More...
 
kStatus GoSetup_SetYGapFillingWindow (GoSetup setup, k64f window)
 Sets the y-direction gap-filling window. More...
 
kStatus GoSetup_SetYSmoothingWindow (GoSetup setup, k64f window)
 Sets the y-direction smoothing window. More...
 
kStatus GoSetup_SetZSubsampling (GoSetup setup, GoRole role, k32u zSubsampling)
 Sets the current z-resolution divider. More...
 
GoSurfaceGeneration GoSetup_SurfaceGeneration (GoSetup setup)
 Gets the surface generation module, used for surface generation configuration. More...
 
k64f GoSetup_TrackingAreaHeight (GoSetup setup, GoRole role)
 Gets the tracking window height. More...
 
k64f GoSetup_TrackingAreaHeightLimitMax (GoSetup setup, GoRole role)
 Gets the tracking window height maximum limit. More...
 
k64f GoSetup_TrackingAreaHeightLimitMin (GoSetup setup, GoRole role)
 Gets the tracking window height minimum limit. More...
 
kBool GoSetup_TrackingEnabled (GoSetup setup, GoRole role)
 Determines if tracking is enabled. More...
 
k64f GoSetup_TrackingSearchThreshold (GoSetup setup, GoRole role)
 Gets the tracking window search threshold. More...
 
k64f GoSetup_TriggerDelay (GoSetup setup)
 Gets the trigger delay. More...
 
k64f GoSetup_TriggerDelayLimitMax (GoSetup setup)
 Reports the maximum trigger delay, based on current settings. More...
 
k64f GoSetup_TriggerDelayLimitMin (GoSetup setup)
 Reports the minimum trigger delay, based on current settings. More...
 
kBool GoSetup_TriggerGateEnabled (GoSetup setup)
 Reports whether the trigger gate feature is currently enabled. More...
 
GoTrigger GoSetup_TriggerSource (GoSetup setup)
 Gets the trigger source for profile triggering. More...
 
GoTriggerUnits GoSetup_TriggerUnit (GoSetup setup)
 Gets the system trigger units. More...
 
kBool GoSetup_XGapFillingEnabled (GoSetup setup)
 Gets the status of x-direction gap-filling. More...
 
k64f GoSetup_XGapFillingWindow (GoSetup setup)
 Gets the x-direction gap-filling window. More...
 
k64f GoSetup_XGapFillingWindowLimitMax (GoSetup setup)
 Gets the x-direction gap-filling window maximum. More...
 
k64f GoSetup_XGapFillingWindowLimitMin (GoSetup setup)
 Gets the x-direction gap-filling window minimum. More...
 
kBool GoSetup_XSmoothingEnabled (GoSetup setup)
 Gets the status of x-direction smoothing. More...
 
k64f GoSetup_XSmoothingWindow (GoSetup setup)
 Gets the x-direction smoothing window. More...
 
k64f GoSetup_XSmoothingWindowLimitMax (GoSetup setup)
 Gets the x-direction smoothing window maximum. More...
 
k64f GoSetup_XSmoothingWindowLimitMin (GoSetup setup)
 Gets the x-direction smoothing window minimum. More...
 
k32u GoSetup_XSubsampling (GoSetup setup, GoRole role)
 Gets the current x-resolution divider. More...
 
k32u GoSetup_XSubsamplingOptionAt (GoSetup setup, GoRole role, k32u index)
 Gets the x-resolution option at the specified index. More...
 
kSize GoSetup_XSubsamplingOptionCount (GoSetup setup, GoRole role)
 Gets the count of valid x-resolution options. More...
 
kBool GoSetup_YGapFillingEnabled (GoSetup setup)
 Gets the status of y-direction gap-filling. More...
 
k64f GoSetup_YGapFillingWindow (GoSetup setup)
 Gets the y-direction gap-filling window. More...
 
k64f GoSetup_YGapFillingWindowLimitMax (GoSetup setup)
 Gets the y-direction gap-filling window maximum. More...
 
k64f GoSetup_YGapFillingWindowLimitMin (GoSetup setup)
 Gets the y-direction gap-filling window minimum. More...
 
kBool GoSetup_YSmoothingEnabled (GoSetup setup)
 Gets the status of y-direction smoothing. More...
 
k64f GoSetup_YSmoothingWindow (GoSetup setup)
 Gets the y-direction smoothing window. More...
 
k64f GoSetup_YSmoothingWindowLimitMax (GoSetup setup)
 Gets the y-direction smoothing window maximum. More...
 
k64f GoSetup_YSmoothingWindowLimitMin (GoSetup setup)
 Gets the y-direction smoothing window minimum. More...
 
k32u GoSetup_ZSubsampling (GoSetup setup, GoRole role)
 Gets the current z-resolution divider. More...
 
k32u GoSetup_ZSubsamplingOptionAt (GoSetup setup, GoRole role, k32u index)
 Gets the z-resolution option at the specified index. More...
 
kSize GoSetup_ZSubsamplingOptionCount (GoSetup setup, GoRole role)
 Gets the count of valid z-resolution options. More...
 

Member Function Documentation

k64f GoSetup_ActiveAreaHeight ( GoSetup  setup,
GoRole  role 
)

Gets the active area height.

Parameters
setupGoSetup object.
roleDetermines which sensor to retrieve the value from.
heightActive area height (mm).
Returns
Operation status.
k64f GoSetup_ActiveAreaHeightLimitMax ( GoSetup  setup,
GoRole  role 
)

Gets the maximum valid value for the ActiveAreaHeight setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Maximum valid ActiveAreaHeight value (mm).
k64f GoSetup_ActiveAreaHeightLimitMin ( GoSetup  setup,
GoRole  role 
)

Gets the minimum valid value for the ActiveAreaHeight setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Minimum valid ActiveAreaHeight value (mm).
k64f GoSetup_ActiveAreaLength ( GoSetup  setup,
GoRole  role 
)

Gets the active area Length.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Active area Length (mm).
k64f GoSetup_ActiveAreaLengthLimitMax ( GoSetup  setup,
GoRole  role 
)

Gets the maximum valid value for the ActiveAreaLength setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Maximum valid ActiveAreaLength value (mm).
k64f GoSetup_ActiveAreaLengthLimitMin ( GoSetup  setup,
GoRole  role 
)

Gets the minimum valid value for the ActiveAreaLength setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Minimum valid ActiveAreaLength value (mm).
k64f GoSetup_ActiveAreaWidth ( GoSetup  setup,
GoRole  role 
)

Gets the active area width.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Active area width (mm).
k64f GoSetup_ActiveAreaWidthLimitMax ( GoSetup  setup,
GoRole  role 
)

Gets the maximum valid value for the ActiveAreaWidth setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Maximum valid ActiveAreaWidth value (mm).
k64f GoSetup_ActiveAreaWidthLimitMin ( GoSetup  setup,
GoRole  role 
)

Gets the minimum valid value for the ActiveAreaWidth setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Minimum valid ActiveAreaWidth value (mm).
k64f GoSetup_ActiveAreaX ( GoSetup  setup,
GoRole  role 
)

Gets the active area x origin.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Active area x origin (mm).
k64f GoSetup_ActiveAreaXLimitMax ( GoSetup  setup,
GoRole  role 
)

Gets the maximum valid value for the ActiveAreaX setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Maximum valid ActiveAreaX value (mm).
k64f GoSetup_ActiveAreaXLimitMin ( GoSetup  setup,
GoRole  role 
)

Gets the minimum valid value for the ActiveAreaX setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Minimum valid ActiveAreaX value (mm).
k64f GoSetup_ActiveAreaY ( GoSetup  setup,
GoRole  role 
)

Gets the active area Y.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Active area Y (mm).
k64f GoSetup_ActiveAreaYLimitMax ( GoSetup  setup,
GoRole  role 
)

Gets the maximum valid value for the ActiveAreaY setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Maximum valid ActiveAreaY value (mm).
k64f GoSetup_ActiveAreaYLimitMin ( GoSetup  setup,
GoRole  role 
)

Gets the minimum valid value for the ActiveAreaY setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Minimum valid ActiveAreaY value (mm).
k64f GoSetup_ActiveAreaZ ( GoSetup  setup,
GoRole  role 
)

Gets the active area z origin.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Active area z origin (mm).
k64f GoSetup_ActiveAreaZLimitMax ( GoSetup  setup,
GoRole  role 
)

Gets the maximum valid value for the ActiveAreaZ setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Maximum valid ActiveAreaZ value (mm).
k64f GoSetup_ActiveAreaZLimitMin ( GoSetup  setup,
GoRole  role 
)

Gets the minimum valid value for the ActiveAreaZ setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Minimum valid ActiveAreaZ value (mm).
kStatus GoSetup_AddExposureStep ( GoSetup  setup,
GoRole  role,
k64f  exposure 
)

Adds an exposure step.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
exposureExpsosure value (microseconds).
Returns
Operation status.
kBool GoSetup_AlignmentEncoderCalibrateEnabled ( GoSetup  setup)

Gets the value of the post alignment encoder calibration setting.

Parameters
setupGoSetup object.
Returns
kTrue if post alignment encoder calibration is enabled. kFalse otherwise.
GoAlignmentTarget GoSetup_AlignmentStationaryTarget ( GoSetup  setup)

Gets the target type used for alignment calibration.

Parameters
setupGoSetup object.
Returns
Alignment target type (none, disk, or bar).
GoAlignmentType GoSetup_AlignmentType ( GoSetup  setup)

Gets the type used for alignment calibration.

Parameters
setupGoSetup object.
Returns
Alignment type (stationary or moving).
k64f GoSetup_BarHeight ( GoSetup  setup)

Gets the height of the bar used for travel calibration.

Parameters
setupGoSetup object.
Returns
Bar height (mm).
kSize GoSetup_BarHoleCount ( GoSetup  setup)

Gets the number of holes that are defined on the calibration bar.

Parameters
setupGoSetup object.
Returns
Hole count.
k64f GoSetup_BarHoleDiameter ( GoSetup  setup)

Gets the diameter of holes that are defined on the calibration bar.

Parameters
setupGoSetup object.
Returns
Hole diameter (mm).
k64f GoSetup_BarHoleDistance ( GoSetup  setup)

Gets the distance between holes that are defined on the calibration bar.

Parameters
setupGoSetup object.
Returns
Hole distance (mm).
k64f GoSetup_BarWidth ( GoSetup  setup)

Gets the width of the bar used for travel calibration.

Parameters
setupGoSetup object.
Returns
Bar width (mm).
kStatus GoSetup_ClearExposureSteps ( GoSetup  setup,
GoRole  role 
)

Removes all exposure steps.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Operation status.
GoState GoSetup_DefaultState ( GoSetup  setup)

Gets the default state of the sensor system upon boot.

Parameters
setupGoSetup object
Returns
Default state.
k64f GoSetup_DiskDiameter ( GoSetup  setup)

Gets the diameter of the disk used for travel calibration.

Parameters
setupGoSetup object.
Returns
Disk diameter (mm).
k64f GoSetup_DiskHeight ( GoSetup  setup)

Gets the height of the disk used for travel calibration.

Parameters
setupGoSetup object.
Returns
Disk height (mm).
k64f GoSetup_DynamicExposureMax ( GoSetup  setup,
GoRole  role 
)

Gets the maximum value for the Dynamic Exposure setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Maximum Dynamic Exposure value (microseconds).
k64f GoSetup_DynamicExposureMin ( GoSetup  setup,
GoRole  role 
)

Gets the minimum value for the Dynamic Exposure setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Minimum Dynamic Exposure value (microseconds).
kStatus GoSetup_EnableAlignmentEncoderCalibrate ( GoSetup  setup,
kBool  enabled 
)

Enables encoder calibration after alignment.

Parameters
setupGoSetup object.
enabledkTrue to enable encoder calibration after alignment, kFalse to disable it.
Returns
Operation status.
kStatus GoSetup_EnableIntensity ( GoSetup  setup,
kBool  enable 
)

Enables profile intensity collection.

Parameters
setupGoSetup object.
enablekTRUE to enable, or kFALSE to disable.
Returns
Operation status.
kStatus GoSetup_EnableMaxFrameRate ( GoSetup  setup,
kBool  enable 
)

Enables or disables operation at full frame rate (ignoring frame rate setting).

Parameters
setupGoSetup object.
enableEnables full frame rate operation.
Returns
Operation status.
kStatus GoSetup_EnableTracking ( GoSetup  setup,
GoRole  role,
kBool  enable 
)

Enables tracking.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
enablekTRUE to enable, or kFALSE to disable.
Returns
Operation status.
kStatus GoSetup_EnableTriggerGate ( GoSetup  setup,
kBool  enable 
)

Sets the trigger gate feature.

Parameters
setupGoSetup object.
enableEnables trigger gate operation.
Returns
Operation status.
kStatus GoSetup_EnableXGapFilling ( GoSetup  setup,
kBool  enable 
)

Sets the status of x-direction gap-filling.

Parameters
setupGoSetup object.
enableEnable or disable x-gap-filling
Returns
Operation status.
kStatus GoSetup_EnableXSmoothing ( GoSetup  setup,
kBool  enabled 
)

Sets the status of x-direction smoothing.

Parameters
setupGoSetup object.
enabledEnable or disable x-smoothing
Returns
Operation status.
kStatus GoSetup_EnableYGapFilling ( GoSetup  setup,
kBool  enable 
)

Sets the status of y-direction gap-filling.

Parameters
setupGoSetup object.
enableEnable or disable y-gap-filling
Returns
Operation status.
kStatus GoSetup_EnableYSmoothing ( GoSetup  setup,
kBool  enable 
)

Sets the status of y-direction smoothing.

Parameters
setupGoSetup object.
enableEnable or disable y-smoothing
Returns
Operation status.
k64f GoSetup_EncoderSpacing ( GoSetup  setup)

Gets the current encoder period for encoder-based triggering.

Parameters
setupGoSetup object.
Returns
Encoder period (mm).
k64f GoSetup_EncoderSpacingLimitMax ( GoSetup  setup)

Constraint for the maximum valid value of the EncoderPeriod setting.

Parameters
setupGoSetup object.
Returns
Maximum valid EncoderPeriod setting (mm).
k64f GoSetup_EncoderSpacingLimitMin ( GoSetup  setup)

Constraint for the minimum valid value of the EncoderPeriod setting.

Parameters
setupGoSetup object.
Returns
Minimum valid EncoderPeriod setting (mm).
GoEncoderTriggerMode GoSetup_EncoderTriggerMode ( GoSetup  setup)

Gets the encoder trigger mode.

Parameters
setupGoSetup object.
Returns
Encoder trigger mode.
k64f GoSetup_Exposure ( GoSetup  setup,
GoRole  role 
)

Gets the exposure value.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Exposure value (microseconds).
k32u GoSetup_ExposureDelay ( GoSetup  setup,
GoRole  role 
)

Gets the exposure delay.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Exposure delay (microseconds).
k64f GoSetup_ExposureLimitMax ( GoSetup  setup,
GoRole  role 
)

Gets the maximum valid value for the Exposure setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Maximum valid Exposure value (microseconds).
k64f GoSetup_ExposureLimitMin ( GoSetup  setup,
GoRole  role 
)

Gets the minimum valid value for the Exposure setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Maximum valid Exposure value (microseconds).
GoExposureMode GoSetup_ExposureMode ( GoSetup  setup,
GoRole  role 
)

Gets the exposure mode.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Exposure mode.
k64f GoSetup_ExposureStepAt ( GoSetup  setup,
GoRole  role,
k32u  index 
)

Get the exposure step value specified by index.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
indexThe index of the exposure step to get.
Returns
The exposure step value (microseconds).
kSize GoSetup_ExposureStepCount ( GoSetup  setup,
GoRole  role 
)

Get the number of exposure steps defined.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
The count of exposure steps.
k64f GoSetup_FrameRate ( GoSetup  setup)

Reports the currently configured frame rate.

Parameters
setupGoSetup object.
Returns
Maximum frame rate (Hz).
k64f GoSetup_FrameRateLimitMax ( GoSetup  setup)

Constraint for the maximum valid value of the Frame Rate setting.

Parameters
setupGoSetup object.
Returns
Maximum valid Frame Rate setting (hz).
k64f GoSetup_FrameRateLimitMin ( GoSetup  setup)

Constraint for the minimum valid value of the Frame Rate setting.

Parameters
setupGoSetup object.
Returns
Minimum valid Frame Rate setting (hz).
k32u GoSetup_FrontCameraHeight ( GoSetup  setup,
GoRole  role 
)

Gets the camera region-of-interest height.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Region of interest height (pixels).
k32u GoSetup_FrontCameraWidth ( GoSetup  setup,
GoRole  role 
)

Gets the camera region-of-interest width.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Region of interest width (pixels).
k32u GoSetup_FrontCameraX ( GoSetup  setup,
GoRole  role 
)

Gets the camera region-of-interest x origin.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Region of interest x origin (pixels).
k32u GoSetup_FrontCameraY ( GoSetup  setup,
GoRole  role 
)

Gets the camera region-of-interest y origin.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Region of interest y origin (pixels).
kBool GoSetup_IntensityEnabled ( GoSetup  setup)

Reports whether the profile intensity collection is enabled.

Parameters
setupGoSetup object.
Returns
kTRUE if enabled, or kFALSE if disabled.
GoLayout GoSetup_Layout ( GoSetup  setup)

Gets the layout configuration module.

Parameters
setupGoSetup object.
Returns
Layout configuration module.
kBool GoSetup_MaxFrameRateEnabled ( GoSetup  setup)

Reports whether or not system is configured to operate at full frame rate.

Parameters
setupGoSetup object.
Returns
True if system operates at full frame rate; false otherwise.
GoOrientation GoSetup_Orientation ( GoSetup  setup)

Gets the transform orientation identifier.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Orientation identifier.
GoPartDetection GoSetup_PartDetection ( GoSetup  setup)

Gets the part detection module, used for part detection configuration.

Parameters
setupGoSetup object.
Returns
Part detection configuration module.
k64f GoSetup_PlateHeight ( GoSetup  setup)

Gets the height of the plate used for travel calibration.

Parameters
setupGoSetup object.
Returns
Plate height (mm).
kSize GoSetup_PlateHoleCount ( GoSetup  setup)

Gets the number of holes that are defined on the calibration plate.

Parameters
setupGoSetup object.
Returns
Hole count.
k64f GoSetup_PlateRefHoleDiameter ( GoSetup  setup)

Gets the diameter of the reference hole defined on the calibration plate.

Parameters
setupGoSetup object.
Returns
Hole diameter (mm).
k64f GoSetup_PlateSecHoleDiameter ( GoSetup  setup)

Gets the diameter of the secondary hole defined on the calibration plate.

Parameters
setupGoSetup object.
Returns
Hole diameter (mm).
GoMode GoSetup_ScanMode ( GoSetup  setup)

Gets the default operation mode of the sensor system.

Parameters
setupGoSetup object.
Returns
Operation mode.
kStatus GoSetup_SetActiveAreaHeight ( GoSetup  setup,
GoRole  role,
k64f  height 
)

Sets the active area height.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
heightActive area height (mm).
Returns
Operation status.
k64f GoSetup_SetActiveAreaLength ( GoSetup  setup,
GoRole  role,
k64f  Length 
)

Sets the active area Length.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
LengthActive area Length (mm).
Returns
Operation status.
k64f GoSetup_SetActiveAreaWidth ( GoSetup  setup,
GoRole  role,
k64f  width 
)

Sets the active area width.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
widthActive area width (mm).
Returns
Operation status.
k64f GoSetup_SetActiveAreaX ( GoSetup  setup,
GoRole  role,
k64f  x 
)

Sets the active area x origin.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
xActive area x origin (mm).
Returns
Operation status.
k64f GoSetup_SetActiveAreaY ( GoSetup  setup,
GoRole  role,
k64f  Y 
)

Sets the active area Y.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
YActive area Y (mm).
Returns
Operation status.
k64f GoSetup_SetActiveAreaZ ( GoSetup  setup,
GoRole  role,
k64f  z 
)

Sets the active area z origin.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
zActive area z origin (mm).
Returns
Operation status.
kStatus GoSetup_SetAlignmentStationaryTarget ( GoSetup  setup,
GoAlignmentTarget  target 
)

Sets the target type used for alignment calibration.

Parameters
setupGoSetup object.
targetAlignment target type (none, disk, or bar).
Returns
Operation status.
kStatus GoSetup_SetAlignmentType ( GoSetup  setup,
GoAlignmentType  Type 
)

Sets the type used for alignment.

Parameters
setupGoSetup object.
typeAlignment type (stationary or moving).
Returns
Operation status.
kStatus GoSetup_SetBarHeight ( GoSetup  setup,
k64f  height 
)

Sets the height of the bar used for travel calibration.

Parameters
setupGoSetup object.
heightBar height (mm).
Returns
Operation status.
kStatus GoSetup_SetBarHoleCount ( GoSetup  setup,
kSize  count 
)

Sets the number of holes that are defined on the calibration bar.

Parameters
setupGoSetup object.
countHole count.
Returns
Operation status.
kStatus GoSetup_SetBarHoleDiameter ( GoSetup  setup,
k64f  diameter 
)

Sets the diameter of holes that are defined on the calibration bar.

Parameters
setupGoSetup object.
diameterHole diameter (mm).
Returns
Operation status.
kStatus GoSetup_SetBarHoleDistance ( GoSetup  setup,
k64f  distance 
)

Sets the distance between holes that are defined on the calibration bar.

Parameters
setupGoSetup object.
distanceHole distance (mm).
Returns
Operation status.
kStatus GoSetup_SetBarWidth ( GoSetup  setup,
k64f  width 
)

Sets the width of the bar used for travel calibration.

Parameters
setupGoSetup object.
widthBar width (mm).
Returns
Operation status.
kStatus GoSetup_SetDefaultState ( GoSetup  setup,
GoState  state 
)

Sets the default state of the sensor system upon boot.

Parameters
setupGoSetup object.
stateDefault state.
Returns
Operation status.
kStatus GoSetup_SetDiskDiameter ( GoSetup  setup,
k64f  diameter 
)

Sets the diameter of the disk used for travel calibration.

Parameters
setupGoSetup object.
diameterDisk diameter (mm).
Returns
Operation status.
kStatus GoSetup_SetDiskHeight ( GoSetup  setup,
k64f  height 
)

Sets the height of the disk used for travel calibration.

Parameters
setupGoSetup object.
heightDisk height (mm).
Returns
Operation status.
kStatus GoSetup_SetDynamicExposureMax ( GoSetup  setup,
GoRole  role,
k64f  exposure 
)

Sets the maximum value for the Dynamic Exposure setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
exposureMaximum Dynamic Exposure value (microseconds).
Returns
Operation status.
kStatus GoSetup_SetDynamicExposureMin ( GoSetup  setup,
GoRole  role,
k64f  exposure 
)

Sets the minimum value for the Dynamic Exposure setting.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
exposureMinumum Dynamic Exposure value (microseconds).
Returns
Operation status.
kStatus GoSetup_SetEncoderSpacing ( GoSetup  setup,
k64f  period 
)

Sets the current encoder period for encoder-based triggering.

Parameters
setupGoSetup object.
periodEncoder period (mm).
Returns
Operation status.
kStatus GoSetup_SetEncoderTriggerMode ( GoSetup  setup,
GoEncoderTriggerMode  mode 
)

Sets the encoder trigger mode.

Parameters
setupGoSetup object.
modeEncoder trigger mode.
Returns
Profile trigger source.
kStatus GoSetup_SetExposure ( GoSetup  setup,
GoRole  role,
k64f  exposure 
)

Sets the exposure value.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
exposureIntended exposure value.
Returns
Operation status.
kStatus GoSetup_SetExposureDelay ( GoSetup  setup,
GoRole  role,
k32u  delay 
)

Sets the exposure delay.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
delayExposure delay (microseconds).
Returns
Operation status.
kStatus GoSetup_SetExposureMode ( GoSetup  setup,
GoRole  role,
GoExposureMode  mode 
)

Sets the exposure mode.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
modeThe exposure mode to use.
Returns
Operation status.
kStatus GoSetup_SetFrameRate ( GoSetup  setup,
k64f  frameRate 
)

Sets the current frame rate for time-based triggering.

Note, calling this function also implicitly disables the FullFrameRate option.

Parameters
setupGoSetup object.
frameRateFrame Rate value (hz).
Returns
Operation status.
kStatus GoSetup_SetOrientation ( GoSetup  setup,
GoOrientation  orientation 
)

Sets the transform x-offset.

Parameters
setupGoSetup object.
orientationOffset value (mm).
Returns
Operation status.
kStatus GoSetup_SetPlateHeight ( GoSetup  setup,
k64f  height 
)

Sets the height of the plate used for travel calibration.

Parameters
setupGoSetup object.
heightPlate height (mm).
Returns
Operation status.
kStatus GoSetup_SetPlateHoleCount ( GoSetup  setup,
kSize  count 
)

Sets the number of holes that are defined on the calibration plate.

Parameters
setupGoSetup object.
countHole count.
Returns
Operation status.
kStatus GoSetup_SetPlateRefHoleDiameter ( GoSetup  setup,
k64f  diameter 
)

Sets the diameter of the reference hole defined on the calibration plate.

Parameters
setupGoSetup object.
diameterHole diameter (mm).
Returns
Operation status.
kStatus GoSetup_SetPlateSecHoleDiameter ( GoSetup  setup,
k64f  diameter 
)

Sets the diameter of the secondary hole defined on the calibration plate.

Parameters
setupGoSetup object.
diameterHole diameter (mm).
Returns
Operation status.
kStatus GoSetup_SetScanMode ( GoSetup  setup,
GoMode  mode 
)

Sets the default operation mode of the sensor system.

Parameters
setupGoSetup object.
modeOperation mode.
Returns
Operation status.
kStatus GoSetup_SetTrackingAreaHeight ( GoSetup  setup,
GoRole  role,
k64f  height 
)

Sets the tracking window height.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
heightTracking window height (mm).
Returns
Operation status.
kStatus GoSetup_SetTrackingSearchThreshold ( GoSetup  setup,
GoRole  role,
k64f  threshold 
)

Sets the tracking window search threshold.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
thresholdTracking window search threshold (%)
Returns
Operation status.
kStatus GoSetup_SetTriggerDelay ( GoSetup  setup,
k64f  delay 
)

Sets the trigger delay.

Depending on GoDomain, units are uS or mm.

Parameters
setupGoSetup object.
delayTrigger delay (uS or mm).
Returns
Operation status.
kStatus GoSetup_SetTriggerSource ( GoSetup  setup,
GoTrigger  source 
)

Sets the trigger source for profile triggering.

Parameters
setupGoSetup object.
sourceProfile trigger source.
Returns
Operation status.
kStatus GoSetup_SetTriggerUnit ( GoSetup  setup,
GoTriggerUnits  unit 
)

Sets the system trigger units.

Ignored if GoSetup_TriggerSource is time or encoder

Parameters
setupGoSetup object.
unitThe system trigger unit.
Returns
Operation status.
kStatus GoSetup_SetXGapFillingWindow ( GoSetup  setup,
k64f  window 
)

Sets the status of x-direction gap-filling.

Parameters
setupGoSetup object.
windowEnable or disable x-gap-filling
Returns
Operation status.
kStatus GoSetup_SetXSmoothingWindow ( GoSetup  setup,
k64f  window 
)

Sets the x-direction smoothing window.

Parameters
setupGoSetup object.
windowThe x-smoothing window (mm).
Returns
Operation status.
kStatus GoSetup_SetXSubsampling ( GoSetup  setup,
GoRole  role,
k32u  xSubsampling 
)

Sets the current x-resolution divider.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
xResolutionX resolution divider (e.g. 1 - full res, 2 - half res).
Returns
Operation status.
kStatus GoSetup_SetYGapFillingWindow ( GoSetup  setup,
k64f  window 
)

Sets the y-direction gap-filling window.

Parameters
setupGoSetup object.
windowThe y-gap-filling window (mm).
Returns
kStatus GoSetup_SetYSmoothingWindow ( GoSetup  setup,
k64f  window 
)

Sets the y-direction smoothing window.

Parameters
setupGoSetup object.
windowThe y-smoothing window (mm).
Returns
Operation status.
kStatus GoSetup_SetZSubsampling ( GoSetup  setup,
GoRole  role,
k32u  zSubsampling 
)

Sets the current z-resolution divider.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
zResolutionZ resolution divider (e.g. 1 - full res, 2 - half res).
Returns
Operation status.
GoSurfaceGeneration GoSetup_SurfaceGeneration ( GoSetup  setup)

Gets the surface generation module, used for surface generation configuration.

Parameters
setupGoSetup object.
Returns
Surface generation configuration module.
k64f GoSetup_TrackingAreaHeight ( GoSetup  setup,
GoRole  role 
)

Gets the tracking window height.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Tracking window height (mm).
k64f GoSetup_TrackingAreaHeightLimitMax ( GoSetup  setup,
GoRole  role 
)

Gets the tracking window height maximum limit.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Tracking window height max(mm).
k64f GoSetup_TrackingAreaHeightLimitMin ( GoSetup  setup,
GoRole  role 
)

Gets the tracking window height minimum limit.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Tracking window height min(mm).
kBool GoSetup_TrackingEnabled ( GoSetup  setup,
GoRole  role 
)

Determines if tracking is enabled.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
kTRUE if enabled, or kFALSE if disabled.
k64f GoSetup_TrackingSearchThreshold ( GoSetup  setup,
GoRole  role 
)

Gets the tracking window search threshold.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Tracking window search threshold (%).
k64f GoSetup_TriggerDelay ( GoSetup  setup)

Gets the trigger delay.

Depending on GoDomain, units are uS or mm.

Parameters
setupGoSetup object.
Returns
Trigger delay (uS or mm).
k64f GoSetup_TriggerDelayLimitMax ( GoSetup  setup)

Reports the maximum trigger delay, based on current settings.

Depending on GoDomain, units are uS or mm.

Parameters
setupGoSetup object.
Returns
Maximum trigger delay (uS or mm).
k64f GoSetup_TriggerDelayLimitMin ( GoSetup  setup)

Reports the minimum trigger delay, based on current settings.

Depending on GoDomain, units are uS or mm.

Parameters
setupGoSetup object.
Returns
Minimum trigger delay (uS or mm).
kBool GoSetup_TriggerGateEnabled ( GoSetup  setup)

Reports whether the trigger gate feature is currently enabled.

Parameters
setupGoSetup object.
Returns
kTRUE if enabled, or kFALSE if disabled.
GoTrigger GoSetup_TriggerSource ( GoSetup  setup)

Gets the trigger source for profile triggering.

Parameters
setupGoSetup object.
Returns
Profile trigger source.
GoTriggerUnits GoSetup_TriggerUnit ( GoSetup  setup)

Gets the system trigger units.

Ignored if GoSetup_TriggerSource is time or encoder

Parameters
setupGoSetup object.
Returns
The system domain.
kBool GoSetup_XGapFillingEnabled ( GoSetup  setup)

Gets the status of x-direction gap-filling.

Parameters
setupGoSetup object.
Returns
True if x-gap-filling is enabled.
k64f GoSetup_XGapFillingWindow ( GoSetup  setup)

Gets the x-direction gap-filling window.

Parameters
setupGoSetup object.
Returns
The x-gap-filling window (mm).
k64f GoSetup_XGapFillingWindowLimitMax ( GoSetup  setup)

Gets the x-direction gap-filling window maximum.

Parameters
setupGoSetup object.
Returns
The x-gap-filling window max (mm).
k64f GoSetup_XGapFillingWindowLimitMin ( GoSetup  setup)

Gets the x-direction gap-filling window minimum.

Parameters
setupGoSetup object.
Returns
The x-gap-filling window min (mm).
kBool GoSetup_XSmoothingEnabled ( GoSetup  setup)

Gets the status of x-direction smoothing.

Parameters
setupGoSetup object.
Returns
True if x-smoothing is enabled.
k64f GoSetup_XSmoothingWindow ( GoSetup  setup)

Gets the x-direction smoothing window.

Parameters
setupGoSetup object.
Returns
The x-smoothing window (mm).
k64f GoSetup_XSmoothingWindowLimitMax ( GoSetup  setup)

Gets the x-direction smoothing window maximum.

Parameters
setupGoSetup object.
Returns
The x-smoothing window max (mm).
k64f GoSetup_XSmoothingWindowLimitMin ( GoSetup  setup)

Gets the x-direction smoothing window minimum.

Parameters
setupGoSetup object.
Returns
The x-smoothing window min (mm).
k32u GoSetup_XSubsampling ( GoSetup  setup,
GoRole  role 
)

Gets the current x-resolution divider.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
x resolution divider (e.g. 1 - full res, 2 - half res).
k32u GoSetup_XSubsamplingOptionAt ( GoSetup  setup,
GoRole  role,
k32u  index 
)

Gets the x-resolution option at the specified index.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
indexIndex of the desired resolution option.
Returns
X resolution option.
kSize GoSetup_XSubsamplingOptionCount ( GoSetup  setup,
GoRole  role 
)

Gets the count of valid x-resolution options.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Count of x-resolution options.
kBool GoSetup_YGapFillingEnabled ( GoSetup  setup)

Gets the status of y-direction gap-filling.

Parameters
setupGoSetup object.
Returns
True if y-gap-filling is enabled.
k64f GoSetup_YGapFillingWindow ( GoSetup  setup)

Gets the y-direction gap-filling window.

Parameters
setupGoSetup object.
Returns
The y-gap-filling window (mm).
k64f GoSetup_YGapFillingWindowLimitMax ( GoSetup  setup)

Gets the y-direction gap-filling window maximum.

Parameters
setupGoSetup object.
Returns
The y-gap-filling window max (mm).
k64f GoSetup_YGapFillingWindowLimitMin ( GoSetup  setup)

Gets the y-direction gap-filling window minimum.

Parameters
setupGoSetup object.
Returns
The y-gap-filling window min (mm).
kBool GoSetup_YSmoothingEnabled ( GoSetup  setup)

Gets the status of y-direction smoothing.

Parameters
setupGoSetup object.
Returns
True if y-smoothing is enabled.
k64f GoSetup_YSmoothingWindow ( GoSetup  setup)

Gets the y-direction smoothing window.

Parameters
setupGoSetup object.
Returns
The y-smoothing window (mm).
k64f GoSetup_YSmoothingWindowLimitMax ( GoSetup  setup)

Gets the y-direction smoothing window maximum.

Parameters
setupGoSetup object.
Returns
The y-smoothing window max (mm).
k64f GoSetup_YSmoothingWindowLimitMin ( GoSetup  setup)

Gets the y-direction smoothing window minimum.

Parameters
setupGoSetup object.
Returns
The y-smoothing window min (mm).
k32u GoSetup_ZSubsampling ( GoSetup  setup,
GoRole  role 
)

Gets the current z-resolution divider.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Z resolution divider (e.g. 1 - full res, 2 - half res).
k32u GoSetup_ZSubsamplingOptionAt ( GoSetup  setup,
GoRole  role,
k32u  index 
)

Gets the z-resolution option at the specified index.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
indexIndex of the desired resolution option.
Returns
Z resolution option.
kSize GoSetup_ZSubsamplingOptionCount ( GoSetup  setup,
GoRole  role 
)

Gets the count of valid z-resolution options.

Parameters
setupGoSetup object.
roleDetermines which sensor to apply changes to.
Returns
Count of z-resolution options.

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