GoWebScanSettings.h

Go to the documentation of this file.

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

#ifndef GO_WEB_SCAN_SETTINGS_H
#define GO_WEB_SCAN_SETTINGS_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanUtilities.h>
#include <kApi/Data/kXml.h>
#include <kApi/Data/kArrayList.h>
#include <kApi/Data/kString.h>

/**
* @class   GoWebScanSettings
* @extends kObject
* @ingroup GoWebScanSdk-Config
* @brief   Represents a container for user-configurable settings of the system. The class 
*          reads and writes the settings from/to an XML. These settings describe the 
*          configuration and orientation of the system, processing parameters, and desired
*          outputs. The format of the XML is similar to the chroma+scan 3x00 station settings
*          but is not directly equivalent as additional parameters  have been added. However,
*          for any fields that exist in both formats, the chroma+scan 3x00 values can be reused.
*          The settings are divided into system-level settings (GoWebScanSettings),
*          group settings (GoWebScanSettingsGroup), and sensor settings 
*          (GoWebScanSettingsSensor).
* @see     GoWebScanSettingsGroup, GoWebScanSettingsSensor
*/
typedef kObject GoWebScanSettings;

/**
* @class   GoWebScanSettingsGroup
* @extends kObject
* @ingroup GoWebScanSdk-Config
* @brief   Represents a container for user-configurable settings of a group within the
*          system. Groups represent planes (top or bottom).
*/
typedef kObject GoWebScanSettingsGroup;

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

/*
* GoWebScanSettings
*/

/**
 * Constructs a GoWebScanSettings object.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    Receives the constructed GoWebScanSettings object.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_Construct(GoWebScanSettings* settings, kAlloc allocator);

/**
 * Loads the settings XML from a specified path and constructs and initializes a
 * GoWebScanSettings object with the values read from the XML.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    Receives the loaded GoWebScanSettings object.
 * @param   fileName    Path of the settings file.
 * @param   alloc       Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_Load(GoWebScanSettings* settings, const kChar* fileName, kAlloc alloc);

/**
 * Stores the settings XML to a specified path.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   fileName    Path of the settings file.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_Store(GoWebScanSettings settings, const kChar* fileName);

/**
 * Enables vision data in the system. If enabled, and if vision sensors are connected, the
 * system will output vision system messages if a section is defined.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   enable      Boolean to enable vision.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_EnableVision(GoWebScanSettings settings, kBool enable);

/**
 * Gets the flag for whether vision data is enabled. Refer to GoWebScanSettings_EnableVision().
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Boolean for whether vision is enabled.
 */
GoWebScanFx(kBool) GoWebScanSettings_VisionEnabled(GoWebScanSettings settings);

/**
 * Enables tracheid data in the system. If enabled, and if tracheid-capable sensors are 
 * connected, the system will output tracheid system messages if a section is defined.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   enable      Boolean to enable tracheid.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_EnableTracheid(GoWebScanSettings settings, kBool enable);

/**
* Gets the flag for whether tracheid data is enabled.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Boolean for whether tracheid is enabled.
*/
GoWebScanFx(kBool) GoWebScanSettings_TracheidEnabled(GoWebScanSettings settings);

/**
 * Sets the thread count for processing tasks concurrently. This field is optional; if not set,
 * the thread count will be maximized to the number of CPU cores by default. Note that system
 * calibration processing is not concurrent.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Number of threads.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetConcurrency(GoWebScanSettings settings, k32s value);

/**
 * Gets the thread count for processing tasks concurrently. 
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Number of threads.
 */
GoWebScanFx(k32s) GoWebScanSettings_Concurrency(GoWebScanSettings settings);

/**
 * Sets the encoder resolution in mils/tick. Represents the distance (mils) per encoder pulse.
 * This value will be positive if the encoder count increases when the board travels in the
 * forward direction. 4x quadrature decoding is assumed.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Encoder resolution (mils/tick).
 * @return  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetEncoderResolution(GoWebScanSettings settings, k64f value);

/**
 * Gets the encoder resolution in mils/tick. Refer to GoWebScanSettings_SetEncoderResolution().
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Encoder resolution (mils/tick).
 */
GoWebScanFx(k64f) GoWebScanSettings_EncoderResolution(GoWebScanSettings settings);

/**
 * Enables simulating forward motion by overriding encoder values in data messages with
 * simulated values. The simulated speed is set by GoWebScanSettings_SetSimulatedSpeed.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Enables an internal encoder simulator.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetEncoderSimulated(GoWebScanSettings settings, kBool value);

/**
 * Gets the flag for whether the encoder simulator is enabled. Refer to GoWebScanSettings_SetEncoderSimulated().
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Boolean for whether the encoder simulator is enabled.
 */
GoWebScanFx(kBool) GoWebScanSettings_EncoderSimulated(GoWebScanSettings settings);

/**
 * Sets the simulated encoder speed. This is an optional field that can be used to simulate
 * forward motion (mils/second). When this property is present in the settings file, GoWebScan
 * will override the encoder values in data messages with simulated values that are based on
 * time.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Simulated encoder speed (mils/second).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetSimulatedSpeed(GoWebScanSettings settings, k64f value);

/**
* Gets the simulated encoder speed. Refer to GoWebScanSettings_SetSimulatedSpeed().
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Simulated encoder speed (mils/second).
*/
GoWebScanFx(k64f) GoWebScanSettings_SimulatedSpeed(GoWebScanSettings settings);

/**
 * Sets the travel orientation which specifies the direction of conveyor movement: Moving Toward
 * (1) or Moving Away (0). Moving Toward implies that objects on the conveyor are moving toward
 * the observer when the system is viewed from the front.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Travel orientation.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetTravelOrientation(GoWebScanSettings settings, k32s value);

/**
 * Gets the travel orientation which specifies the direction of conveyor movement: Moving Toward
 * (1) or Moving Away (0). Moving Toward implies that objects on the conveyor are moving toward
 * the observer when the system is viewed from the front.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Travel orientation.
 */
GoWebScanFx(k32s) GoWebScanSettings_TravelOrientation(GoWebScanSettings settings);

/**
 * Sets the sensor Y orientation for a given plane: Facing Toward (1) or Facing Away (0). The
 * sensor logo and labels are visible when sensors are facing toward.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   plane       System plane (top or bottom).
 * @param   value       Sensor Y orientation.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetSensorYOrientation(GoWebScanSettings settings, GoWebScanSystemPlane plane, k32s value);

/**
 * Gets the sensor Y orientation for a given plane: Facing Toward (1) or Facing Away (0). The
 * sensor logo and labels are visible when sensors are facing toward.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   plane       System plane (top or bottom).
 * @return              Sensor Y orientation.
 */
GoWebScanFx(k32s) GoWebScanSettings_SensorYOrientation(GoWebScanSettings settings, k32s plane);

/**
 * Sets the sensor X orientation which represents whether the X-axis (length) increasing from
 * left-to-right (1) or right-to-left (0). In a left-to-right system (as viewed from the front),
 * the zero reference is on the left and sensor indices increase left-to-right. In a right-to-
 * left system, the zero reference is on the right and sensor indices increase right-to-left.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Sensor X orientation.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetXOrientation(GoWebScanSettings settings, k32s value);

/**
 * Gets the sensor X orientation. Refer to GoWebScanSettings_SetXOrientation().
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Sensor X orientation.
 * @see                 GoWebScanSettings_SetXOrientation                   
 */
GoWebScanFx(k32s) GoWebScanSettings_XOrientation(GoWebScanSettings settings);

/**
 * Sets whether GoWebScan should use the per-sensor X-center values provided in the settings
 * file, or calculate them from sensor indices (e.g. 0:12000, 1:36000, 2:60000, ...).
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Boolean to use X-centers.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetUseXCenters(GoWebScanSettings settings, kBool value);

/**
 * Gets the flag for whether GoWebScan uses user-defined X-centers.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Boolean to use X-centers.
 */
GoWebScanFx(kBool) GoWebScanSettings_UseXCenters(GoWebScanSettings settings);

/**
 * Sets the frame rate to configure profile sensors to, in Hz. Note that the vision frame
 * rate will be calculated from the profile frame rate to ensure no gaps in vision coverage
 * occur and that the vision sensors do not interfere with profile sensors.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Frame rate (Hz).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetProfileFrameRate(GoWebScanSettings settings, k32u value);

/**
 * Gets the profile frame rate in Hz.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Frame rate (Hz).
 */
GoWebScanFx(k32u) GoWebScanSettings_ProfileFrameRate(GoWebScanSettings settings);

/**
 * Sets the profile exposure in microseconds.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Profile exposure (microseconds).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetProfileExposure(GoWebScanSettings settings, k32u value);

/**
 * Gets the profile exposure in microseconds.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Profile exposure (microseconds).
 */
GoWebScanFx(k32u) GoWebScanSettings_ProfileExposure(GoWebScanSettings settings);

/**
* Sets the vision exposure in microseconds.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Vision exposure (microseconds).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetVisionExposure(GoWebScanSettings settings, k32u value);

/**
* Gets the vision exposure in microseconds.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Vision exposure (microseconds).
*/
GoWebScanFx(k32u) GoWebScanSettings_VisionExposure(GoWebScanSettings settings);

/**
* Sets the tracheid exposure in microseconds.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Tracheid exposure (microseconds).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetTracheidExposure(GoWebScanSettings settings, k32u value);

/**
* Gets the tracheid exposure in microseconds.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Tracheid exposure (microseconds).
*/
GoWebScanFx(k32u) GoWebScanSettings_TracheidExposure(GoWebScanSettings settings);

/**
* Sets the profile X resolution (mils per profile pixel, along board length). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Profile X resolution (mils/pixel).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetProfileXResolution(GoWebScanSettings settings, k32s value);

/**
* Gets the profile X resolution (mils per profile pixel, along board length). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Profile X resolution (mils/pixel).
*/
GoWebScanFx(k32s) GoWebScanSettings_ProfileXResolution(GoWebScanSettings settings);

/**
* Sets the profile Y resolution (mils per profile pixel, across board width). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Profile Y resolution (mils/pixel).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetProfileYResolution(GoWebScanSettings settings, k32s value);

/**
* Gets the profile Y resolution (mils per profile pixel, across board width). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Profile Y resolution (mils/pixel).
*/
GoWebScanFx(k32s) GoWebScanSettings_ProfileYResolution(GoWebScanSettings settings);

/**
* Sets the vision X resolution (mils per vision pixel, along board length).
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Vision X resolution (mils/pixel).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetVisionXResolution(GoWebScanSettings settings, k32s value);

/**
* Gets the vision X resolution (mils per vision pixel, along board length). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Vision X resolution (mils/pixel).
*/
GoWebScanFx(k32s) GoWebScanSettings_VisionXResolution(GoWebScanSettings settings);

/**
* Sets the vision Y resolution (mils per vision pixel, across board width). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Vision Y resolution (mils/pixel).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetVisionYResolution(GoWebScanSettings settings, k32s value);

/**
* Gets the vision Y resolution (mils per vision pixel, across board width). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Vision Y resolution (mils/pixel).
*/
GoWebScanFx(k32s) GoWebScanSettings_VisionYResolution(GoWebScanSettings settings);

/**
* Sets the tracheid X resolution (mils per tracheid pixel, along board length). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Tracheid X resolution (mils/pixel).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetTracheidXResolution(GoWebScanSettings settings, k32s value);

/**
* Gets the tracheid X resolution (mils per tracheid pixel, along board length). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Tracheid X resolution (mils/pixel).
*/
GoWebScanFx(k32s) GoWebScanSettings_TracheidXResolution(GoWebScanSettings settings);

/**
* Sets the tracheid Y resolution (mils per tracheid value, across board width). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Tracheid Y resolution (mils/pixel).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetTracheidYResolution(GoWebScanSettings settings, k32s value);

/**
* Gets the tracheid Y resolution (mils per tracheid value, across board width). Output data will be 
* resampled to this resolution.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Tracheid Y resolution (mils/pixel).
*/
GoWebScanFx(k32s) GoWebScanSettings_TracheidYResolution(GoWebScanSettings settings);

/**
 * Sets the width of the data (mils) included in each profile, vision, or tracheid output tile.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Tile width (mils).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetTileWidth(GoWebScanSettings settings, k32s value);

/**
 * Gets the width of the data (mils) included in each profile, vision, or tracheid output tile.
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Tile width (mils).
 */
GoWebScanFx(k32s) GoWebScanSettings_TileWidth(GoWebScanSettings settings);

/**
 * Sets the maximum distance to fill gaps in data along the X-axis (mils). For all data types
 * (profile, tracheid, vision), this value determines the maximum gap between cameras that will
 * be filled by connecting the data from adjacent cameras. Gaps can occur when target objects
 * are close to the sensors, or when sensors are mounted with space between each device. For
 * profile and tracheid cameras, this value also determines the maximum x-distance for
 * interpolation between two valid laser spots when resampling data within a single camera.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Gap fill distance (mils).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetGapFill(GoWebScanSettings settings, k32s value);

/**
* Gets the maximum distance to fill gaps in data along the X-axis (mils). Refer to GoWebScanSettings_SetGapFill().
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Gap fill distance (mils).
*/
GoWebScanFx(k32s) GoWebScanSettings_GapFill(GoWebScanSettings settings);

/**
 * Sets the maximum amount of redundant camera information that can be blended together at the x-
 * boundary between two cameras (mils). Blending occurs only when the fields-of-view between
 * adjacent cameras have non-zero overlap.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Blending distance (mils).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetOverlapBlend(GoWebScanSettings settings, k32s value);

/**
* Gets the overlap blend distance in mils. Refer to GoWebScanSettings_SetOverlapBlend().
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Blending distance (mils).
*/
GoWebScanFx(k32s) GoWebScanSettings_OverlapBlend(GoWebScanSettings settings);

/**
 * Sets the method used to resample profile points along the X-axis: Nearest Neighbor (0), or
 * Linear Interpolation (1).
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Interpolation method.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetProfileInterpolation(GoWebScanSettings settings, GoWebScanInterpolation value);

/**
 * Gets the profile interpolation method: Nearest Neighbor (0), or Linear Interpolation (1).
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Interpolation method.
 */
GoWebScanFx(GoWebScanInterpolation) GoWebScanSettings_ProfileInterpolation(GoWebScanSettings settings);

/**
 * Sets whether GoWebScan should remove profile points contained within obstruction regions from
 * output data (1) or include all profile points output data (0).
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Boolean to enable obstruction filter.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetObstructionFilter(GoWebScanSettings settings, kBool value);

/**
 * Gets flag for whether the obstruction filter is enabled.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Boolean if obstruction filter is enabled.
 */
GoWebScanFx(kBool) GoWebScanSettings_ObstructionFilter(GoWebScanSettings settings);

/**
 * Sets whether GoWebScan should remove tracheid and vision data where there is no corresponding
 * profile data (1) or include all data in detection output (0).
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Boolean to enable the background filter.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetDetectBackgroundFilter(GoWebScanSettings settings, kBool value);

/**
* Gets flag for whether the background filter is enabled. Refer to GoWebScanSettings_SetDetectBackgroundFilter().
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Boolean if background filter is enabled.
*/
GoWebScanFx(kBool) GoWebScanSettings_DetectBackgroundFilter(GoWebScanSettings settings);

/**
 * Sets whether profile points which are along the board side edge and report an offset range from
 * neighbouring spots should be corrected. Side edge spots are modified to report the range of the 
 * adjacent spot that is on the board, giving the board edge a 90 degree angle and more accurate 
 * length instead of a curved edge. 
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Boolean to enable side extension of the board.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetDetectSideExtension(GoWebScanSettings settings, kBool value);

/**
 * Gets flag for whether extending the board side edge to correct for distortions is enabled.
 * Refer to GoWebScanSettings_SetDetectSideExtension().
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Boolean if side extension is enabled.
 */
GoWebScanFx(kBool) GoWebScanSettings_DetectSideExtension(GoWebScanSettings settings);

/**
 * Sets the type of object detection trigger: Global (0) or Local (1). An object is
 * detected when the amount of visible target material (measured along the X-axis) exceeds the
 * TriggerLength threshold. With a local trigger, the visible target material must be connected
 * (contiguous). With a global trigger, the total amount of visible target material in the
 * system field-of-view is considered.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Detection trigger style.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetDetectTriggerStyle(GoWebScanSettings settings, GoWebScanDetectionStyle value);

/**
 * Gets the detection trigger style. Refer to GoWebScanSettings_SetDetectTriggerStyle().
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Detection trigger style.
 */
GoWebScanFx(GoWebScanDetectionStyle) GoWebScanSettings_DetectTriggerStyle(GoWebScanSettings settings);

/**
 * Sets the length (mils) of material used to trigger object on/off events, not including
 * material inside obstruction regions.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Detection trigger length (mils).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetDetectTriggerLength(GoWebScanSettings settings, k32s value);

/**
 * Gets the detection trigger length in mils. Refer to GoWebScanSettings_SetDetectTriggerLength().
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Detection trigger length (mils).
 */
GoWebScanFx(k32s) GoWebScanSettings_DetectTriggerLength(GoWebScanSettings settings);

/**
 * Sets the size of the margins (mils) that will be added to the leading and trailing edge of
 * each detected object.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Detection edge margin (mils).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetDetectEdgeMargin(GoWebScanSettings settings, k32s value);

/**
 * Gets the detection edge margin in mils. Refer to GoWebScanSettings_SetDetectEdgeMargin().
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Detection edge margin (mils).
 */
GoWebScanFx(k32s) GoWebScanSettings_DetectEdgeMargin(GoWebScanSettings settings);

/**
 * Sets the maximum width of a detection output (mils), including edge margins. When objects
 * exceed this width, they will be segmented into multiple output messages.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Detection maximum width (mils).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetDetectMaxWidth(GoWebScanSettings settings, k32s value);

/**
* Gets the detection maximum width in mils. Refer to GoWebScanSettings_SetDetectMaxWidth().
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Detection maximum width (mils).
*/
GoWebScanFx(k32s) GoWebScanSettings_DetectMaxWidth(GoWebScanSettings settings);

/**
 * Sets whether GoWebScan should attempt to remove or correct edge measurement anomalies (1) or
 * leave them unaltered (0).
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Boolean for whether the edge filter is enabled.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetDetectEdgeFilter(GoWebScanSettings settings, kBool value);

/**
* Gets a flag for whether the detection edge filter is enabled. Refer to GoWebScanSettings_SetDetectEdgeFilter().
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Boolean for whether the edge filter is enabled.
*/
GoWebScanFx(kBool) GoWebScanSettings_DetectEdgeFilter(GoWebScanSettings settings);

/**
 * Sets whether GoWebScan should attempt to detect calibration reference holes (1),
 * or assume that sensors are mounted at their nominal locations along the X-axis (0). This
 * setting applies to vision-enabled systems only and is used during system calibration.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Boolean for whether the detection of calibration locators is enabled.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetCalDetectLocators(GoWebScanSettings settings, kBool value);

/**
* Gets a flag for whether the detection of calibration locators is enabled.
* Refer to GoWebScanSettings_SetCalDetectLocators().
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Calibration locator detection enabled.
*/
GoWebScanFx(kBool) GoWebScanSettings_CalDetectLocators(GoWebScanSettings settings);

/**
* Sets whether GoWebScan enables (1) or disables (0) the use of target intensities
* for each color channel during vision system calibration.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Boolean to enable target vision intensities.
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetCalUseVisionIntensity(GoWebScanSettings settings, kBool value);

/**
 * Gets a flag for whether the use of target intensities for each color channel during vision
 * system calibration is enabled.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Boolean for whether target vision intensities are enabled.
 */
GoWebScanFx(kBool) GoWebScanSettings_CalUseVisionIntensity(GoWebScanSettings settings);

/**
* Sets the desired red intensity level for the calibration target (1 - 255). This is used 
* during vision system calibration.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Red target intensity level.
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetCalVisionIntensityR(GoWebScanSettings settings, k8u value);

/**
* Gets the target red intensity level for vision system calibration.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Red target intensity level.
*/
GoWebScanFx(k8u) GoWebScanSettings_CalVisionIntensityR(GoWebScanSettings settings);

/**
* Sets the desired green intensity level for the calibration target (1 - 255). This is used 
* during vision system calibration.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Green target intensity level.
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetCalVisionIntensityG(GoWebScanSettings settings, k8u value);

/**
* Gets the target green intensity level for vision system calibration.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Green target intensity level.
*/
GoWebScanFx(k8u) GoWebScanSettings_CalVisionIntensityG(GoWebScanSettings settings);

/**
* Sets the desired blue intensity level for the calibration target (1 - 255). This is used 
* during vision system calibration.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Blue target intensity level.
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetCalVisionIntensityB(GoWebScanSettings settings, k8u value);

/**
* Gets the target blue intensity level for vision system calibration.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Blue target intensity level.
*/
GoWebScanFx(k8u) GoWebScanSettings_CalVisionIntensityB(GoWebScanSettings settings);

/**
 * Sets the offset applied to the X-coordinates of all data (profile, vision, tracheid) in Web
 * or Detection mode (mils). This setting is used for X-alignment between multiple servers, and
 * should be written by the user application at the end of system calibration. The X-reference
 * for a single server is calculated during system calibration and available through
 * GoWebScanCal_SystemXRef. The user application should calculate the overall X bias, which is
 * done by averaging the X-references from all servers, and set the X-adjustment for each server
 * as the X bias minus the server's own X-reference.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       X adjustment offset (mils).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetCalXAdjustment(GoWebScanSettings settings, k32s value);

/**
* Gets the X adjustment offset in mils. Refer to GoWebScanSettings_SetCalXAdjustment() for details.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              X adjustment offset (mils).
*/
GoWebScanFx(k32s) GoWebScanSettings_CalXAdjustment(GoWebScanSettings settings);

/**
* Sets the offset applied to the Y-coordinates of all data (profile, vision, tracheid) in Web
* or Detection mode (mils). This setting is used for Y-alignment between multiple servers, and
* should be written by the user application at the end of system calibration. The Y-reference
* for a single server is calculated during system calibration and available through
* GoWebScanCal_SystemYRef. The user application should calculate the overall Y bias, which is
* done by averaging the X-references from all servers, and set the Y-adjustment for each server
* as the Y bias minus the server's own Y-reference.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @param   value       Y adjustment offset (mils).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettings_SetCalYAdjustment(GoWebScanSettings settings, k32s value);

/**
* Gets the Y adjustment offset in mils. Refer to GoWebScanSettings_SetCalYAdjustment() for details.
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Y adjustment offset (mils).
*/
GoWebScanFx(k32s) GoWebScanSettings_CalYAdjustment(GoWebScanSettings settings);

/**
 * Sets the divisor to use when calculating minimum Y-interval for retained data during
 * calibration data collection
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Y internal divisor.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetCalYIntervalDivisor(GoWebScanSettings settings, k64f value);

/**
 * Gets the Y interval divisor which is used when calculating minimum Y-interval for retained
 * data during calibration data collection
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Y internal divisor.
 */
GoWebScanFx(k64f) GoWebScanSettings_CalYIntervalDivisor(GoWebScanSettings settings);

/**
 * Sets whether to manually remove regions from the calibration input data via user-defined
 * obstructions (1) or to automatically detect conveyor hardware regions (0).These regions are
 * specified via sensor obstructions (GoWebScanSettingsSensor_AddObstruction()) and typically
 * represent conveyor hardware regions. When this field is disabled, the calibration will
 * automatically detect conveyor hardware regions to remove from the input data.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   value       Boolean to enable using user-defined obstructions during calibration.
 * @return              Operation status.
 * @see                 GoWebScanSettingsSensor_AddObstruction                     
 */
GoWebScanFx(kStatus) GoWebScanSettings_SetUseObstructions(GoWebScanSettings settings, kBool value);

/**
* Gets a flag for whether to manually remove regions from the calibration input data via 
* user-defined obstructions (1) or to automatically detect conveyor hardware regions (0).
* 
* @public              @memberof GoWebScanSettings
* @param   settings    GoWebScanSettings object.
* @return              Boolean to enable using user-defined obstructions during calibration.
*/
GoWebScanFx(kBool) GoWebScanSettings_CalUseObstructions(GoWebScanSettings settings);

/**
 * Gets the number of groups (representing planes) in the system.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Number of groups.
 */
GoWebScanFx(kSize) GoWebScanSettings_GroupCount(GoWebScanSettings settings);

/**
 * Gets the GoWebScanSettingsGroup object representing a group at a specified index.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   index       Group index.
 * @return              GoWebScanSettingsGroup object representing group.
 */
GoWebScanFx(GoWebScanSettingsGroup) GoWebScanSettings_GroupAt(GoWebScanSettings settings, kSize index);

/**
 * Gets the number of sensors in the system.
 * 
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              Number of sensors.
 */
GoWebScanFx(kSize) GoWebScanSettings_SensorCount(GoWebScanSettings settings);

/**
 * Gets the GoWebScanSettingsSensor object representing a sensor at a specified index in the system.
 *
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @param   index       Sensor index.
 * @return              GoWebScanSettingsSensor object representing sensor.
 */
GoWebScanFx(GoWebScanSettingsSensor) GoWebScanSettings_SensorAt(GoWebScanSettings settings, kSSize index);

/**
 * Gets the GoWebScanSettings file schema version.
 *
 * @public              @memberof GoWebScanSettings
 * @param   settings    GoWebScanSettings object.
 * @return              GoWebScanSettings file schema version.
 */
GoWebScanFx(k32u) GoWebScanSettings_SchemaVersion(GoWebScanSettings settings);

/*
* GoWebScanSettingsGroup
*/

/**
 * Constructs a GoWebScanSettingsGroup object.
 * 
 * @public              @memberof GoWebScanSettingsGroup
 * @param   group       Receives the constructed GoWebScanSettingsGroup object.
 * @param   parent      Settings for the system the group is part of.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsGroup_Construct(GoWebScanSettingsGroup* group, GoWebScanSettings parent, kAlloc allocator);

/**
 * Sets the system plane for the group.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   plane   System plane
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetPlane(GoWebScanSettingsGroup group, GoWebScanSystemPlane plane);

/**
 * Sets the number of sensors in the group.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   count   Number of sensors.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetSensorCount(GoWebScanSettingsGroup group, kSize count);

/**
 * Adds a section to the group. Sections are used to outputs of a specified plane and data type
 * spanning a specified region in X.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   section Section to add to the group.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsGroup_AddSection(GoWebScanSettingsGroup group, const GoWebScanSection* section);

/**
 * Removes a section from the group. Sections are used to outputs of a specified plane and data type
 * spanning a specified region in X.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   index   Index of the section to remove.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsGroup_RemoveSection(GoWebScanSettingsGroup group, kSize index);

/**
 * Clears all sections from the list.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsGroup_ClearSections(GoWebScanSettingsGroup group);

/**
 * Adds a sensor, as defined by a GoWebScanSettingsSensor object, to the group.
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   sensor  Sensor to add to the group.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsGroup_AddSensor(GoWebScanSettingsGroup group, GoWebScanSettingsSensor sensor);

/**
* Clears and disposes all sensors from the group.
* @public          @memberof GoWebScanSettingsGroup
* @param   group   GoWebScanSettingsGroup object.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettingsGroup_ClearSensors(GoWebScanSettingsGroup group);

/**
 * Gets the number of sensors in the group.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @return          Number of sensors in group.
 */
GoWebScanFx(kSize) GoWebScanSettingsGroup_SensorCount(GoWebScanSettingsGroup group);

/**
 * Gets the GoWebScanSettingsSensor object representing a sensor at a specified index 
 * in the group.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   index   Zero-based index of the.
 * @return          Sensor at the specified index.
 */
GoWebScanFx(GoWebScanSettingsSensor) GoWebScanSettingsGroup_SensorAt(GoWebScanSettingsGroup group, kSize index);

/**
 * Gets the settings of the system the group is in.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @return          System settings.
 */
GoWebScanFx(GoWebScanSettings) GoWebScanSettingsGroup_Parent(GoWebScanSettingsGroup group);

/**
 * Gets the system plane of a group.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @return          System plane.
 */
GoWebScanFx(GoWebScanSystemPlane) GoWebScanSettingsGroup_Plane(GoWebScanSettingsGroup group);

/**
 * Gets the number of sections defined for the group.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @return          Number of sections in group.
 */
GoWebScanFx(kSize) GoWebScanSettingsGroup_SectionCount(GoWebScanSettingsGroup group);

/**
 * Gets a pointer to the section at a specified index.
 *  
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   index   Section index.
 * @return          Pointer to the section.
 */
GoWebScanFx(GoWebScanSection*) GoWebScanSettingsGroup_SectionAt(GoWebScanSettingsGroup group, kSize index);

/**
 * Sets the section ID.
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   index   Section index.
 * @param   value   Section ID.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetSectionId(GoWebScanSettingsGroup group, kSize index, k32s value);

/**
* Gets the section ID.
* 
* @public          @memberof GoWebScanSettingsGroup
* @param   group   GoWebScanSettingsGroup object.
* @param   index   Section index.
* @return          Section ID
*/
GoWebScanFx(k32s) GoWebScanSettingsGroup_SectionId(GoWebScanSettingsGroup group, kSize index);

/**
 * Sets the section type. Profile (0), Vision (1), or Tracheid (2).
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   index   Section index.
 * @param   value   Section type.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetSectionType(GoWebScanSettingsGroup group, kSize index, k32s value);

/**
 * Gets the section type. Profile (0), Vision (1), or Tracheid (2).
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   index   Section index.
 * @return          Section type.
 */
GoWebScanFx(k32s) GoWebScanSettingsGroup_SectionType(GoWebScanSettingsGroup group, kSize index);

/**
 * Sets the start of section along the X-axis (length), in system coordinates (mils).
 * 
 * @public          @memberof GoWebScanSettingsGroup
 * @param   group   GoWebScanSettingsGroup object.
 * @param   index   Section index.
 * @param   value   Section start along X-axis (mils).
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetSectionX0(GoWebScanSettingsGroup group, kSize index, k32s value);

/**
* Gets the start of section along the X-axis (length), in system coordinates (mils).
* 
* @public          @memberof GoWebScanSettingsGroup
* @param   group   GoWebScanSettingsGroup object.
* @param   index   Section index. 
* @return          Section start along X-axis (mils).
*/
GoWebScanFx(k32s) GoWebScanSettingsGroup_SectionX0(GoWebScanSettingsGroup group, kSize index);

/**
* Sets the end of section along the X-axis (length), in system coordinates (mils). Should be 
* greater than X0 set in GoWebScanSettingsGroup_SetSectionX0().
* 
* @public          @memberof GoWebScanSettingsGroup
* @param   group   GoWebScanSettingsGroup object.
* @param   index   Section index.
* @param   value   Section end along X-axis (mils).
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetSectionX1(GoWebScanSettingsGroup group, kSize index, k32s value);

/**
* Gets the end of section along the X-axis (length), in system coordinates (mils).
* 
* @public          @memberof GoWebScanSettingsGroup
* @param   group   GoWebScanSettingsGroup object.
* @param   index   Section index. 
* @return          Section end along X-axis (mils).
*/
GoWebScanFx(k32s) GoWebScanSettingsGroup_SectionX1(GoWebScanSettingsGroup group, kSize index);


/*
* GoWebScanSettingsSensor
*/

/**
* Constructs a GoWebScanSettingsSensor object.
* 
* @public              @memberof GoWebScanSettingsSensor
* @param   sensor      Receives the constructed GoWebScanSettingsSensor object.
* @param   allocator   Memory allocator (or kNULL for default).
* @return              Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettingsSensor_Construct(GoWebScanSettingsSensor* sensor, kAlloc allocator);

/**
 * Sets the parent group the sensor is in.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @param   parent  Parent group settings.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetParent(GoWebScanSettingsSensor sensor, GoWebScanSettingsGroup parent);

/**
 * Sets the index of the sensor within the group.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @param   index   Sensor index within group.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetIndex(GoWebScanSettingsSensor sensor, kSize index);

/**
 * Sets the serial number of the profile sensor in a paired profile-vision
 * GoWebScanSettingsSensor object (for systems with vision).
 * 
 * @public                  @memberof GoWebScanSettingsSensor
 * @param   sensor          GoWebScanSettingsSensor object.
 * @param   serialNumber    Profile serial number.
 * @return                  Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetProfileSerialNumber(GoWebScanSettingsSensor sensor, k32s serialNumber);

/**
* Sets the serial number of the vision sensor in a paired profile-vision
* GoWebScanSettingsSensor object (for systems with vision). This field 
* does not need to be set if no vision is present in the system.
* 
* @public                  @memberof GoWebScanSettingsSensor
* @param   sensor          GoWebScanSettingsSensor object.
* @param   serialNumber    Vision serial number.
* @return                  Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetVisionSerialNumber(GoWebScanSettingsSensor sensor, k32s serialNumber);

/**
 * Sets whether the sensor is enabled.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @param   enabled Boolean for whether sensor is enabled.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetEnabled(GoWebScanSettingsSensor sensor, kBool enabled);

/**
 * Adds an obstruction to the sensor. An obstruction is defined as an ROI in the X-axis and Z-
 * axis (in the sensor's coordinate system) that is ignored by the system. If there are any
 * objects that regularly appear within the field of view of the sensors, such as chain runners,
 * the zones in which those objects appear must be identified before the system will operate
 * correctly in Detection mode. Multiple obstructions can be defined for a single sensor.  
 * 
 * @public              @memberof GoWebScanSettingsSensor
 * @param   sensor      GoWebScanSettingsSensor object.
 * @param   obstruction Pointer to the obstruction to add.
 * @return              Operation status.
 * @see                 GoWebScanObstruction                     
 */
GoWebScanFx(kStatus) GoWebScanSettingsSensor_AddObstruction(GoWebScanSettingsSensor sensor, const GoWebScanObstruction* obstruction);

/**
 * Removes an obstruction from the sensor's list of obstructions.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @param   index   Index of the obstruction.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsSensor_RemoveObstruction(GoWebScanSettingsSensor sensor, kSize index);

/**
 * Removes all obstructions defined for a sensor.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsSensor_ClearObstructions(GoWebScanSettingsSensor sensor);

/**
 * Gets the settings file of the parent group the sensor is part of.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @return          GoWebScanSettingsGroup object representing parent group.
 */
GoWebScanFx(GoWebScanSettingsGroup) GoWebScanSettingsSensor_Parent(GoWebScanSettingsSensor sensor);

/**
 * Gets the system plane the sensor is located in.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @return          System plane of sensor.
 */
GoWebScanFx(GoWebScanSystemPlane) GoWebScanSettingsSensor_Plane(GoWebScanSettingsSensor sensor);

/**
* Gets the index of the sensor with respect to the group.
* 
* @public          @memberof GoWebScanSettingsSensor
* @param   sensor  GoWebScanSettingsSensor object.
* @return          Index of sensor in group.
*/
GoWebScanFx(kSize) GoWebScanSettingsSensor_Index(GoWebScanSettingsSensor sensor);

/**
 * Gets the serial number of the sensor. For systems with vision where the
 * GoWebScanSettingsSensor object represents a profile-vision pair, this
 * returns the profile serial number.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @return          Profile serial number.
 */
GoWebScanFx(k32s) GoWebScanSettingsSensor_ProfileSerialNumber(GoWebScanSettingsSensor sensor);

/**
 * Gets the serial number of the vision sensor in a profile-vision pair (for vision systems
 * only). If the system has no vision, this will return GO_WEB_SCAN_UNASSIGNED_SERIAL_NUMBER.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @return          Vision serial number.
 */
GoWebScanFx(k32s) GoWebScanSettingsSensor_VisionSerialNumber(GoWebScanSettingsSensor sensor);

/**
* Gets a flag for whether the sensor is enabled.
* 
* @public          @memberof GoWebScanSettingsSensor
* @param   sensor  GoWebScanSettingsSensor object.
* @return          Boolean for whether sensor is enabled.
*/
GoWebScanFx(kBool) GoWebScanSettingsSensor_Enabled(GoWebScanSettingsSensor sensor);

/**
 * Gets the effective X center of the sensor in system coordinates (mils). If
 * GoWebScanSettings_SetUseXCenters has been enabled and an X center has been set via
 * GoWebScanSettingsSensor_SetXCenter, this will be returned, otherwise the X center will be
 * calculated assuming nominal 24'' spacing between sensor centers (e.g., 12'', 36'', etc..).
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @return          Effective X center (mils).
 */
GoWebScanFx(k32s) GoWebScanSettingsSensor_EffectiveXCenter(GoWebScanSettingsSensor sensor);

/**
 * Gets the number of obstructions defined for a sensor.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @return          Number of obstructions.
 */
GoWebScanFx(kSize) GoWebScanSettingsSensor_ObstructionCount(GoWebScanSettingsSensor sensor);

/**
 * Gets the obstruction at a specified index.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @param   index   Obstruction index.
 * @return          Pointer to the obstruction.
 */
GoWebScanFx(GoWebScanObstruction*) GoWebScanSettingsSensor_ObstructionAt(GoWebScanSettingsSensor sensor, kSize index);

/**
 * Gets the array list of obstructions defined for a sensor.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @return          Array list of obstructions. Type GoWebScanObstruction.
 */
GoWebScanFx(kArrayList) GoWebScanSettingsSensor_Obstructions(GoWebScanSettingsSensor sensor);

/**
 * Sets the mounting location of the sensor, in system coordinates (mils). This setting
 * has no effect unless GoWebScanSettings_SetUseXCenters() is also enabled.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @param   value   X center of sensor (mils).
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetXCenter(GoWebScanSettingsSensor sensor, k32s value);

/**
 * Gets the mounting location of the sensor, in system coordinates (mils). This setting
 * has no effect unless GoWebScanSettings_SetUseXCenters() is also enabled.
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @return          X center of sensor (mils).
 */ 
GoWebScanFx(k32s) GoWebScanSettingsSensor_XCenter(GoWebScanSettingsSensor sensor);

/**
 * Sets the start of an obstruction zone along the X-axis (length), in sensor coordinates (mils).
 * 
 * @public          @memberof GoWebScanSettingsSensor
 * @param   sensor  GoWebScanSettingsSensor object.
 * @param   index   Obstruction index.
 * @param   value   Start of obstruction in X (mils).
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetObstructionX0(GoWebScanSettingsSensor sensor, kSize index, k32s value);

/**
* Gets the start of an obstruction zone along the X-axis (length), in sensor coordinates (mils).
* 
* @public          @memberof GoWebScanSettingsSensor
* @param   sensor  GoWebScanSettingsSensor object.
* @param   index   Obstruction index.
* @return          Start of obstruction in X (mils).
*/
GoWebScanFx(k32s) GoWebScanSettingsSensor_ObstructionX0(GoWebScanSettingsSensor sensor, kSize index);

/**
* Sets the end of an obstruction zone along the X-axis (length), in sensor coordinates (mils).
* 
* @public          @memberof GoWebScanSettingsSensor
* @param   sensor  GoWebScanSettingsSensor object.
* @param   index   Obstruction index.
* @param   value   End of obstruction in X (mils).
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetObstructionX1(GoWebScanSettingsSensor sensor, kSize index, k32s value);

/**
* Gets the end of an obstruction zone along the X-axis (length), in sensor coordinates (mils).
* 
* @public          @memberof GoWebScanSettingsSensor
* @param   sensor  GoWebScanSettingsSensor object.
* @param   index   Obstruction index.
* @return          End of obstruction in X (mils).
*/
GoWebScanFx(k32s) GoWebScanSettingsSensor_ObstructionX1(GoWebScanSettingsSensor sensor, kSize index);

/**
* Sets the start of an obstruction zone along the Z-axis (height), in sensor coordinates (mils).
* 
* @public          @memberof GoWebScanSettingsSensor
* @param   sensor  GoWebScanSettingsSensor object.
* @param   index   Obstruction index.
* @param   value   Start of obstruction in Z (mils).
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetObstructionZ0(GoWebScanSettingsSensor sensor, kSize index, k32s value);

/**
* Gets the start of an obstruction zone along the Z-axis (height), in sensor coordinates (mils).
* 
* @public          @memberof GoWebScanSettingsSensor
* @param   sensor  GoWebScanSettingsSensor object.
* @param   index   Obstruction index. 
* @return          Start of obstruction in Z (mils).
*/
GoWebScanFx(k32s) GoWebScanSettingsSensor_ObstructionZ0(GoWebScanSettingsSensor sensor, kSize index);

/**
* Sets the end of an obstruction zone along the Z-axis (height), in sensor coordinates (mils).
* 
* @public          @memberof GoWebScanSettingsSensor
* @param   sensor  GoWebScanSettingsSensor object.
* @param   index   Obstruction index.
* @param   value   End of obstruction in Z (mils).
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetObstructionZ1(GoWebScanSettingsSensor sensor, kSize index, k32s value);

/**
* Gets the end of an obstruction zone along the Z-axis (height), in sensor coordinates (mils).
*
* @public          @memberof GoWebScanSettingsSensor
* @param   sensor  GoWebScanSettingsSensor object.
* @param   index   Obstruction index.
* @return          End of obstruction in Z (mils).
*/
GoWebScanFx(k32s) GoWebScanSettingsSensor_ObstructionZ1(GoWebScanSettingsSensor sensor, kSize index);

#include <GoWebScanSdk/GoWebScanSettings.x.h>

#endif