GoWebScanConfigGroup.h

Go to the documentation of this file.

/**
* @file    GoWebScanConfigGroup.h
* @brief   Declares a GoWebScanConfigGroup 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_GROUP_H
#define GO_WEB_SCAN_CONFIG_GROUP_H

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

/**
* @class   GoWebScanConfigGroup
* @extends kObject
* @ingroup GoWebScanSdk-Config
* @brief   Represents a container for group-level parameters which are translated from user 
*          parameters set in GoWebScanSettings. This class contains properties describing
*          the group orientation, and contains a list of sensor configuration objects. 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 GoWebScanConfigGroup;

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

/**
 * Constructs a GoWebScanConfigGroup object.
 * 
 * @public                  @memberof GoWebScanConfigGroup
 * @param   group           Receives the constructed GoWebScanConfigGroup object.
 * @param   config          Parent system-level configuration.
 * @param   settingsGroup   User settings for the 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) GoWebScanConfigGroup_Construct(GoWebScanConfigGroup* group, GoWebScanConfig config, GoWebScanSettingsGroup settingsGroup, GoWebScanCal calibration, kArrayList sensorInfo, kAlloc allocator);

/**
 * Gets the configuration of the system that the group is part of.
 * 
 * @public          @memberof GoWebScanConfigGroup
 * @param   group   GoWebScanConfigGroup object.
 * @return          GoWebScanConfig object representing system configuration.
 */
GoWebScanFx(GoWebScanConfig) GoWebScanConfigGroup_Parent(GoWebScanConfigGroup group);

/**
* Gets the plane of the group.
* 
* @public          @memberof GoWebScanConfigGroup
* @param   group   GoWebScanConfigGroup object.
* @return          Plane of group.
*/
GoWebScanFx(GoWebScanSystemPlane) GoWebScanConfigGroup_Plane(GoWebScanConfigGroup group);

/**
* Gets the Y-orientation of the group. 
* 
* @public          @memberof GoWebScanConfigGroup
* @param   group   GoWebScanConfigGroup object.
* @return          Y-orientation of group.
* @see             GoWebScanYOrientation            
*/
GoWebScanFx(GoWebScanYOrientation) GoWebScanConfigGroup_YOrientation(GoWebScanConfigGroup group);

/**
* Gets the Z-orientation of the group (same as the group's plane).
* 
* @public          @memberof GoWebScanConfigGroup
* @param   group   GoWebScanConfigGroup object.
* @return          Z-orientation of group.
*/
GoWebScanFx(GoWebScanSystemPlane) GoWebScanConfigGroup_ZOrientation(GoWebScanConfigGroup group);

/**
* Gets the maximum node column ID within this group. Each node column represents a camera in the
* system.
* 
* @public          @memberof GoWebScanConfigGroup
* @param   group   GoWebScanConfigGroup object.
* @return          Maximum node column ID within this group.
*/
GoWebScanFx(kSSize) GoWebScanConfigGroup_MaxNodeColumn(GoWebScanConfigGroup group);

/**
* Gets the count of sensors in this group.
* 
* @public          @memberof GoWebScanConfigGroup
* @param   group   GoWebScanConfigGroup object.
* @return          Sensor count.
*/
GoWebScanFx(kSSize) GoWebScanConfigGroup_SensorCount(GoWebScanConfigGroup group);

/**
 * Gets the configuration of a sensor at a specified index in the group.
 * 
 * @public          @memberof GoWebScanConfigGroup
 * @param   group   GoWebScanConfigGroup object.
 * @param   index   Sensor index.
 * @return          Sensor configuration.
 */
GoWebScanFx(GoWebScanConfigSensor) GoWebScanConfigGroup_SensorAt(GoWebScanConfigGroup group, kSSize index);

/**
* Gets the count of nodes in this group. Each node represents a camera in the system.
* 
* @public          @memberof GoWebScanConfigGroup
* @param   group   GoWebScanConfigGroup object.
* @return          Node count.
*/
GoWebScanFx(kSSize) GoWebScanConfigGroup_NodeCount(GoWebScanConfigGroup group);

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

/**
* Gets the count of sections defined for this group.
* 
* @public          @memberof GoWebScanConfigGroup
* @param   group   GoWebScanConfigGroup object.
* @return          Section count.
*/
GoWebScanFx(kSSize) GoWebScanConfigGroup_SectionCount(GoWebScanConfigGroup group);

/**
* Gets the section at a specified index in the group's section list.
* 
* @public          @memberof GoWebScanConfigGroup
* @param   group   GoWebScanConfigGroup object.
* @param   index   Section index.
* @return          Pointer to section.
*/
GoWebScanFx(GoWebScanSection*) GoWebScanConfigGroup_SectionAt(GoWebScanConfigGroup group, kSSize index);

/**
* Update the calibration for this group.
*
* @public                  @memberof GoWebScanConfigGroup
* @param   group           GoWebScanConfigGroup object.
* @param   calibration     System calibration. Set to kNULL if running system uncalibrated or if running system calibration.
* @return                  Operation status.
*/
GoWebScanFx(kStatus) GoWebScanConfigGroup_UpdateCalibration(GoWebScanConfigGroup group, GoWebScanCal calibration);

#include <GoWebScanSdk/GoWebScanConfigGroup.x.h>

#endif