GoWebScan API
GoWebScanSettingsSensor Class Reference

Description

Represents a container for user-configurable settings of a sensor within the system. For systems with vision, a GoWebScanSettingsSensor object represents a pair of vision and profile sensors (sensor mounted together).

Inheritance diagram for GoWebScanSettingsSensor:
Inheritance graph

Public Member Functions

kStatus GoWebScanSettingsSensor_AddObstruction (GoWebScanSettingsSensor sensor, const GoWebScanObstruction *obstruction)
 Adds an obstruction to the sensor. More...
 
kStatus GoWebScanSettingsSensor_ClearObstructions (GoWebScanSettingsSensor sensor)
 Removes all obstructions defined for a sensor. More...
 
kStatus GoWebScanSettingsSensor_Construct (GoWebScanSettingsSensor *sensor, kAlloc allocator)
 Constructs a GoWebScanSettingsSensor object. More...
 
k32s GoWebScanSettingsSensor_EffectiveXCenter (GoWebScanSettingsSensor sensor)
 Gets the effective X center of the sensor in system coordinates (mils). More...
 
kBool GoWebScanSettingsSensor_Enabled (GoWebScanSettingsSensor sensor)
 Gets a flag for whether the sensor is enabled. More...
 
kSize GoWebScanSettingsSensor_Index (GoWebScanSettingsSensor sensor)
 Gets the index of the sensor with respect to the group. More...
 
GoWebScanObstructionGoWebScanSettingsSensor_ObstructionAt (GoWebScanSettingsSensor sensor, kSize index)
 Gets the obstruction at a specified index. More...
 
kSize GoWebScanSettingsSensor_ObstructionCount (GoWebScanSettingsSensor sensor)
 Gets the number of obstructions defined for a sensor. More...
 
kArrayList GoWebScanSettingsSensor_Obstructions (GoWebScanSettingsSensor sensor)
 Gets the array list of obstructions defined for a sensor. More...
 
k32s GoWebScanSettingsSensor_ObstructionX0 (GoWebScanSettingsSensor sensor, kSize index)
 Gets the start of an obstruction zone along the X-axis (length), in sensor coordinates (mils). More...
 
k32s GoWebScanSettingsSensor_ObstructionX1 (GoWebScanSettingsSensor sensor, kSize index)
 Gets the end of an obstruction zone along the X-axis (length), in sensor coordinates (mils). More...
 
k32s GoWebScanSettingsSensor_ObstructionZ0 (GoWebScanSettingsSensor sensor, kSize index)
 Gets the start of an obstruction zone along the Z-axis (height), in sensor coordinates (mils). More...
 
k32s GoWebScanSettingsSensor_ObstructionZ1 (GoWebScanSettingsSensor sensor, kSize index)
 Gets the end of an obstruction zone along the Z-axis (height), in sensor coordinates (mils). More...
 
GoWebScanSettingsGroup GoWebScanSettingsSensor_Parent (GoWebScanSettingsSensor sensor)
 Gets the settings file of the parent group the sensor is part of. More...
 
GoWebScanSystemPlane GoWebScanSettingsSensor_Plane (GoWebScanSettingsSensor sensor)
 Gets the system plane the sensor is located in. More...
 
k32s GoWebScanSettingsSensor_ProfileSerialNumber (GoWebScanSettingsSensor sensor)
 Gets the serial number of the sensor. More...
 
kStatus GoWebScanSettingsSensor_RemoveObstruction (GoWebScanSettingsSensor sensor, kSize index)
 Removes an obstruction from the sensor's list of obstructions. More...
 
kStatus GoWebScanSettingsSensor_SetEnabled (GoWebScanSettingsSensor sensor, kBool enabled)
 Sets whether the sensor is enabled. More...
 
kStatus GoWebScanSettingsSensor_SetIndex (GoWebScanSettingsSensor sensor, kSize index)
 Sets the index of the sensor within the group. More...
 
kStatus GoWebScanSettingsSensor_SetObstructionX0 (GoWebScanSettingsSensor sensor, kSize index, k32s value)
 Sets the start of an obstruction zone along the X-axis (length), in sensor coordinates (mils). More...
 
kStatus GoWebScanSettingsSensor_SetObstructionX1 (GoWebScanSettingsSensor sensor, kSize index, k32s value)
 Sets the end of an obstruction zone along the X-axis (length), in sensor coordinates (mils). More...
 
kStatus GoWebScanSettingsSensor_SetObstructionZ0 (GoWebScanSettingsSensor sensor, kSize index, k32s value)
 Sets the start of an obstruction zone along the Z-axis (height), in sensor coordinates (mils). More...
 
kStatus GoWebScanSettingsSensor_SetObstructionZ1 (GoWebScanSettingsSensor sensor, kSize index, k32s value)
 Sets the end of an obstruction zone along the Z-axis (height), in sensor coordinates (mils). More...
 
kStatus GoWebScanSettingsSensor_SetParent (GoWebScanSettingsSensor sensor, GoWebScanSettingsGroup parent)
 Sets the parent group the sensor is in. More...
 
kStatus GoWebScanSettingsSensor_SetProfileSerialNumber (GoWebScanSettingsSensor sensor, k32s serialNumber)
 Sets the serial number of the profile sensor in a paired profile-vision GoWebScanSettingsSensor object (for systems with vision). More...
 
kStatus GoWebScanSettingsSensor_SetVisionSerialNumber (GoWebScanSettingsSensor sensor, k32s serialNumber)
 Sets the serial number of the vision sensor in a paired profile-vision GoWebScanSettingsSensor object (for systems with vision). More...
 
kStatus GoWebScanSettingsSensor_SetXCenter (GoWebScanSettingsSensor sensor, k32s value)
 Sets the mounting location of the sensor, in system coordinates (mils). More...
 
k32s GoWebScanSettingsSensor_VisionSerialNumber (GoWebScanSettingsSensor sensor)
 Gets the serial number of the vision sensor in a profile-vision pair (for vision systems only). More...
 
k32s GoWebScanSettingsSensor_XCenter (GoWebScanSettingsSensor sensor)
 Gets the mounting location of the sensor, in system coordinates (mils). More...
 

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