GoWebScanCalInput.h

Go to the documentation of this file.

/**
* @file    GoWebScanCalInput.h
* @brief   Declares a GoWebScanCalInput 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_CAL_INPUT_H
#define GO_WEB_SCAN_CAL_INPUT_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @class   GoWebScanCalInput
* @extends kObject
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents Y-matched system data containing a calibration bar, used for 
*          calibration processing. The GoWebScanCalInput object contains a list of 
*          GoWebScanCalInputNode objects which represent containers of individual
*          node messages. The message are raw sensor data and undergo no resampling
*          or merging.
*/
typedef kObject GoWebScanCalInput;

// Forward declarations
typedef kObject GoWebScanCalInputNode; 
typedef kObject GoWebScanCalInputItem; 

/**
 * Constructs a GoWebScanCalInput object.
 * 
 * @public              @memberof GoWebScanCalInput
 * @param   input       Receives the constructed GoWebScanCalInput object.
 * @param   topCount    Number of top nodes.
 * @param   bottomCount Number of bottom nodes.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInput_Construct(GoWebScanCalInput* input, kSize topCount, kSize bottomCount, kAlloc allocator);

/**
 * Sets the properties of the input dataset.
 * 
 * @public              @memberof GoWebScanCalInput
 * @param   input       GoWebScanCalInput object.
 * @param   startTile   Index of starting tile of dataset.
 * @param   tileCount   Number of tiles.
 * @param   tileExtent  Tile extent in Y-axis (mils).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInput_SetTileInfo(GoWebScanCalInput input, k64s startTile, k64s tileCount, k64s tileExtent); 

/**
 * Constructs and adds a node input to the system input. Each node is defined by a unique column,
 * data source, and system plane.
 * 
 * @public          @memberof GoWebScanCalInput
 * @param   input   GoWebScanCalInput object.
 * @param   source  Data source.
 * @param   plane   System plane.
 * @param   column  Node column index.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInput_CreateNode(GoWebScanCalInput input, GoWebScanDataSource source, GoWebScanSystemPlane plane, kSize column);

/**
 * Gets the node input object for a specified column, source, and plane.
 * 
 * @public          @memberof GoWebScanCalInput
 * @param   input   GoWebScanCalInput object.
 * @param   source  Data source.
 * @param   plane   System plane.
 * @param   column  Node column index.
 * @return          GoWebScanCalInputNode object representing node input.
 */
GoWebScanFx(GoWebScanCalInputNode) GoWebScanCalInput_GetNode(GoWebScanCalInput input, GoWebScanDataSource source, GoWebScanSystemPlane plane, kSize column);

/**
 * Gets the start Y position of the input set of data in mils.
 * 
 * @public          @memberof GoWebScanCalInput
 * @param   input   GoWebScanCalInput object.
 * @return          Start Y position (mils).
 */
GoWebScanFx(k64s) GoWebScanCalInput_StartY(GoWebScanCalInput input); 

/**
* Gets the extent of the input data in the Y axis in mils.
* 
* @public          @memberof GoWebScanCalInput
* @param   input   GoWebScanCalInput object.
* @return          Y extent (mils).
*/
GoWebScanFx(k64s) GoWebScanCalInput_YExtent(GoWebScanCalInput input); 

#include <GoWebScanSdk/GoWebScanCalInput.x.h>

#endif