GoWebScanCalInputTileSet.h

Go to the documentation of this file.

/**
* @file    GoWebScanCalInputTileSet.h
* @brief   Declares a GoWebScanCalInputTileSet 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_TILE_SET_H
#define GO_WEB_SCAN_CAL_INPUT_TILE_SET_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanCalInputTile.h>

/**
* @class   GoWebScanCalInputTileSet
* @extends kObject
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents a Y-matched tile spanning a system plane for a particular data type. 
*          These tile sets are provided as input to the calibration bar detector logic.
*/
typedef kObject GoWebScanCalInputTileSet;

/**
 * Constructs a GoWebScanCalInputTileSet object.
 * 
 * @public              @memberof GoWebScanCalInputTileSet
 * @param   set         Receives the constructed GoWebScanCalInputTileSet object.
 * @param   topCount    Number of nodes in the top plane. 
 * @param   bottomCount Number of nodes in the bottom plane.
 * @param   position    Y-axis index of the tile.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputTileSet_Construct(GoWebScanCalInputTileSet* set, kSize topCount, kSize bottomCount, k64s position, kAlloc allocator);

/**
 * Adds a tile to the set at a specific plane and node column for a given data source. Ownership
 * of the input tile is passed to the class and the input tile pointer is set to null afterwards.
 * 
 * @public              @memberof GoWebScanCalInputTileSet
 * @param   set         GoWebScanCalInputTileSet object.
 * @param   tile        Pointer to input tile to add to the set. Pointer is set to kNULL after
 *                      the tile is added.
 * @param   dataSource  Data source.
 * @param   plane       System plane.
 * @param   column      Node column index.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputTileSet_SetTile(GoWebScanCalInputTileSet set, GoWebScanCalInputTile* tile, GoWebScanDataSource dataSource, GoWebScanSystemPlane plane, kSize column);

/**
 * Gets a tile at a specific plane and node column in the set (for a particular data source).
 * 
 * @public              @memberof GoWebScanCalInputTileSet
 * @param   set         GoWebScanCalInputTileSet object.
 * @param   dataSource  Data source.
 * @param   plane       System plane.
 * @param   column      Node column index.
 * @return              Tile at the specified index.
 */
GoWebScanFx(GoWebScanCalInputTile) GoWebScanCalInputTileSet_TileAt(GoWebScanCalInputTileSet set, GoWebScanDataSource dataSource, GoWebScanSystemPlane plane, kSize column);

/**
 * Gets the Y-axis index of the tile.
 * 
 * @public          @memberof GoWebScanCalInputTileSet
 * @param   set     GoWebScanCalInputTileSet object.
 * @return          Y-axis index of the tile.
 */
GoWebScanFx(k64s) GoWebScanCalInputTileSet_Position(GoWebScanCalInputTileSet set);

/**
 * Gets the number of node columns in a plane.
 * 
 * @public          @memberof GoWebScanCalInputTileSet
 * @param   set     GoWebScanCalInputTileSet object.
 * @param   plane   System plane.
 * @return          Number of node columns for a plane.
 */
GoWebScanFx(kSize) GoWebScanCalInputTileSet_ColumnCount(GoWebScanCalInputTileSet set, GoWebScanSystemPlane plane); 

#include <GoWebScanSdk/GoWebScanCalInputTileSet.x.h>

#endif