GoWebScanConfigSensor.h

Go to the documentation of this file.

/**
* @file    GoWebScanConfigSensor.h
* @brief   Declares a GoWebScanConfigSensor object.
*
* @internal
* Copyright (C) 2017-2026 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/

#ifndef GO_WEB_SCAN_CONFIG_SENSOR_H
#define GO_WEB_SCAN_CONFIG_SENSOR_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanSettings.h>
#include <GoWebScanSdk/GoWebScanConfig.h>
#include <GoWebScanSdk/GoWebScanConfigGroup.h>
#include <GoWebScanSdk/GoWebScanCal.h>
#include <GoSdk/GoSdk.h>

/**
* @class   GoWebScanConfigSensor
* @extends kObject
* @ingroup GoWebScanSdk-Config
* @brief   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.
*/
typedef kObject GoWebScanConfigSensor;

// Forward declarations
typedef kObject GoWebScanConfig;
typedef kObject GoWebScanConfigGroup;
typedef kObject GoWebScanConfigNode;

/**
 * Constructs a GoWebScanConfigSensor object.
 * 
 * @public                  @memberof GoWebScanConfigSensor
 * @param   sensor          Receives the constructed GoWebScanConfigSensor object.
 * @param   group           Parent group configuration.
 * @param   settingsSensor  User settings for the sensor.
 * @param   index           Index of sensor in group.
 * @param   calibration     System calibration. Set to kNULL if running system uncalibrated or if
 *                          running system calibration.
 * @param   sensorInfo      List of GoWebScanConfigSensorInfo structs representing information
 *                          from each sensor in the system.
 * @param   allocator       Memory allocator (or kNULL for default).
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanConfigSensor_Construct(GoWebScanConfigSensor* sensor, GoWebScanConfigGroup group, GoWebScanSettingsSensor settingsSensor, 
                                kSize index, GoWebScanCal calibration, const GoWebScanConfigSensorInfo* sensorInfo, kAlloc allocator);

/**
* Gets the configuration of the group that the sensor is part of.
* 
* @public          @memberof GoWebScanConfigSensor
* @param   sensor  GoWebScanConfigSensor object.
* @return          GoWebScanConfigGroup object representing group configuration.
*/
GoWebScanFx(GoWebScanConfigGroup) GoWebScanConfigSensor_Parent(GoWebScanConfigSensor sensor);

/**
 * Gets the serial number of the sensor. In systems with vision sensors, this is the profile
 * sensor's ID.
 * 
 * @public          @memberof GoWebScanConfigSensor
 * @param   sensor  GoWebScanConfigSensor object.
 * @return          Profile sensor ID.
 */
GoWebScanFx(k32s) GoWebScanConfigSensor_ProfileId(GoWebScanConfigSensor sensor);

/**
 * Gets the serial number of the vision sensor in a profile-vision sensor pair (for systems with
 * vision). For systems without vision, this will return GO_WEB_SCAN_UNASSIGNED_SERIAL_NUMBER.
 *
 * @public          @memberof GoWebScanConfigSensor
 * @param   sensor  GoWebScanConfigSensor object.
 * @return          Vision sensor ID.
 */
GoWebScanFx(k32s) GoWebScanConfigSensor_VisionId(GoWebScanConfigSensor sensor);

/**
* Gets the plane of the group the sensor is part of.
*
* @public          @memberof GoWebScanConfigSensor
* @param   sensor  GoWebScanConfigSensor object.
* @return          Plane of group sensor is located in.
*/
GoWebScanFx(k32s) GoWebScanConfigSensor_Plane(GoWebScanConfigSensor sensor);

/**
 * Gets the sensor column within group. Each sensor resides in a particular sensor column
 * within the group. The columns increase left-to-right or right-to-left based on the X
 * orientation. The column includes disabled/missing devices.
 * 
 * @public          @memberof GoWebScanConfigSensor
 * @param   sensor  GoWebScanConfigSensor object.
 * @return          Sensor column.
 */
GoWebScanFx(kSSize) GoWebScanConfigSensor_Column(GoWebScanConfigSensor sensor);

/**
 * Gets the sensor index within group (excludes disabled/missing devices).
 * 
 * @public          @memberof GoWebScanConfigSensor
 * @param   sensor  GoWebScanConfigSensor object.
 * @return          Sensor index.
 */
GoWebScanFx(kSSize) GoWebScanConfigSensor_Index(GoWebScanConfigSensor sensor);

/**
 * Gets the X-orientation of the sensor. Normal (1) or opposite (0). Normal is defined as sensor
 * X-axis aligned to the system X-axis in standard orientation (Refer to GoWebScanConfig for 
* a description of standard orientation).
 * 
 * @public          @memberof GoWebScanConfigSensor
 * @param   sensor  GoWebScanConfigSensor object.
 * @return          Sensor X-orientation.
 * @see             GoWebScanConfig                              
 */
GoWebScanFx(k32s) GoWebScanConfigSensor_XOrientation(GoWebScanConfigSensor sensor);

/**
 * Gets the Y-orientation of the sensor. Normal (1) or opposite (0). Normal is defined as sensor
 * Y-axis opposite to the system Y-axis in standard orientation (Refer to GoWebScanConfig for 
* a description of standard orientation).
 * 
 * @public          @memberof GoWebScanConfigSensor
 * @param   sensor  GoWebScanConfigSensor object.
 * @return          Sensor Y-orientation.
 * @see             GoWebScanConfig                              
 */
GoWebScanFx(k32s) GoWebScanConfigSensor_YOrientation(GoWebScanConfigSensor sensor);

/**
 * Gets the Z-orientation of the sensor. Normal (1) or opposite (0). Normal is defined as sensor
 * Z-axis opposite to the system Z-axis in standard orientation (Refer to GoWebScanConfig for 
* a description of standard orientation).
 * 
 * @public          @memberof GoWebScanConfigSensor
 * @param   sensor  GoWebScanConfigSensor object.
 * @return          Sensor Z-orientation.
 * @see             GoWebScanConfig                     
 */
GoWebScanFx(k32s) GoWebScanConfigSensor_ZOrientation(GoWebScanConfigSensor sensor);

/**
* Gets the sensor calibration-edge-orientation: Normal (1) or opposite (0).
* 
* @public          @memberof GoWebScanConfigSensor
* @param   sensor  GoWebScanConfigSensor object.
* @return          Sensor calibration edge orientation.
*/
GoWebScanFx(k32s) GoWebScanConfigSensor_EOrientation(GoWebScanConfigSensor sensor);

/**
* Gets the count of nodes in the sensor.
* 
* @public          @memberof GoWebScanConfigSensor
* @param   sensor  GoWebScanConfigSensor object.
* @return          Sensor's node count.
*/
GoWebScanFx(kSSize) GoWebScanConfigSensor_NodeCount(GoWebScanConfigSensor sensor);

/**
* Gets the configuration of a node at a specified index in the sensor.
* 
* @public          @memberof GoWebScanConfigSensor
* @param   sensor  GoWebScanConfigSensor object.
* @param   index   Node index.
* @return          Node configuration.
*/
GoWebScanFx(GoWebScanConfigNode) GoWebScanConfigSensor_NodeAt(GoWebScanConfigSensor sensor, kSSize index);

/**
* Gets the list of obstructions defined for the sensor.
* 
* @public          @memberof GoWebScanConfigSensor
* @param   sensor  GoWebScanConfigSensor object.
* @return          List of obstructions. Type GoWebScanObstruction.
*/
GoWebScanFx(kArrayList) GoWebScanConfigSensor_Obstructions(GoWebScanConfigSensor sensor);

/**
* Gets the sensor x-rotation-orientation.
* 
* @public          @memberof GoWebScanConfigSensor
* @param   sensor  GoWebScanConfigSensor object.
* @return          Sensor x-rotation-orientation: normal (1) or opposite (0).
*/
GoWebScanFx(k32s) GoWebScanConfigSensor_TOrientation(GoWebScanConfigSensor sensor);

/**
* Update the calibration.
*
* @public                  @memberof GoWebScanConfigSensor
* @param   sensor          GoWebScanConfigSensor object.
* @param   calibration     System calibration. Set to kNULL if running system uncalibrated or if running system calibration.
* @return                  Operation status.
*/
GoWebScanFx(kStatus) GoWebScanConfigSensor_UpdateCalibration(GoWebScanConfigSensor sensor, GoWebScanCal calibration);

#include <GoWebScanSdk/GoWebScanConfigSensor.x.h>

#endif