GoWebScan API
GoWebScanConfigSensor Class Reference

Description

Represents a container for sensor-level parameters which are translated from user parameters set in GoWebScanSettings. This class contains properties describing the sensor orientation and contains a list of node configuration objects. In systems with vision sensors, this class represents a profile-vision sensor pair (sensors mounted together). This class is intended to be constructed from within a GoWebScanConfig object.

GoWebScanConfig organizes the configuration at the system, group, sensor, and node levels. Configuration of the groups within the system are represented by the GoWebScanConfigGroup class, sensors by the GoWebScanConfigSensor class, and nodes by the GoWebScanConfigNode class. GoWebScanConfig will construct and own these classes.

Inheritance diagram for GoWebScanConfigSensor:
Inheritance graph

Public Member Functions

kSSize GoWebScanConfigSensor_Column (GoWebScanConfigSensor sensor)
 Gets the sensor column within group. More...
 
kStatus GoWebScanConfigSensor_Construct (GoWebScanConfigSensor *sensor, GoWebScanConfigGroup group, GoWebScanSettingsSensor settingsSensor, kSize index, GoWebScanCal calibration, const GoWebScanConfigSensorInfo *sensorInfo, kAlloc allocator)
 Constructs a GoWebScanConfigSensor object. More...
 
k32s GoWebScanConfigSensor_EOrientation (GoWebScanConfigSensor sensor)
 Gets the sensor calibration-edge-orientation: Normal (1) or opposite (0). More...
 
kSSize GoWebScanConfigSensor_Index (GoWebScanConfigSensor sensor)
 Gets the sensor index within group (excludes disabled/missing devices). More...
 
GoWebScanConfigNode GoWebScanConfigSensor_NodeAt (GoWebScanConfigSensor sensor, kSSize index)
 Gets the configuration of a node at a specified index in the sensor. More...
 
kSSize GoWebScanConfigSensor_NodeCount (GoWebScanConfigSensor sensor)
 Gets the count of nodes in the sensor. More...
 
kArrayList GoWebScanConfigSensor_Obstructions (GoWebScanConfigSensor sensor)
 Gets the list of obstructions defined for the sensor. More...
 
GoWebScanConfigGroup GoWebScanConfigSensor_Parent (GoWebScanConfigSensor sensor)
 Gets the configuration of the group that the sensor is part of. More...
 
k32s GoWebScanConfigSensor_Plane (GoWebScanConfigSensor sensor)
 Gets the plane of the group the sensor is part of. More...
 
k32s GoWebScanConfigSensor_ProfileId (GoWebScanConfigSensor sensor)
 Gets the serial number of the sensor. More...
 
k32s GoWebScanConfigSensor_TOrientation (GoWebScanConfigSensor sensor)
 Gets the sensor x-rotation-orientation. More...
 
kStatus GoWebScanConfigSensor_UpdateCalibration (GoWebScanConfigSensor sensor, GoWebScanCal calibration)
 Update the calibration. More...
 
k32s GoWebScanConfigSensor_VisionId (GoWebScanConfigSensor sensor)
 Gets the serial number of the vision sensor in a profile-vision sensor pair (for systems with vision). More...
 
k32s GoWebScanConfigSensor_XOrientation (GoWebScanConfigSensor sensor)
 Gets the X-orientation of the sensor. More...
 
k32s GoWebScanConfigSensor_YOrientation (GoWebScanConfigSensor sensor)
 Gets the Y-orientation of the sensor. More...
 
k32s GoWebScanConfigSensor_ZOrientation (GoWebScanConfigSensor sensor)
 Gets the Z-orientation of the sensor. More...
 

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