GoWebScanCalInputTile.h

Go to the documentation of this file.

/**
* @file    GoWebScanCalInputTile.h
* @brief   Declares a GoWebScanCalInputTile 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_H
#define GO_WEB_SCAN_CAL_INPUT_TILE_H

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

/**
* @class   GoWebScanCalInputTile
* @extends kObject
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents a container for raw sensor messages from a single node used 
*          during calibration data collection.
*/
typedef kObject GoWebScanCalInputTile;

// Forward declaration
typedef kObject GoWebScanCalInputItem; 

/**
 * Constructs a GoWebScanCalInputTile object.
 * 
 * @public              @memberof GoWebScanCalInputTile
 * @param   tile        Receives the constructed GoWebScanCalInputTile object.
 * @param   position    Y-axis index of the tile.
 * @param   time        Timestamp of the tile (microseconds).
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputTile_Construct(GoWebScanCalInputTile* tile, k64s position, k64s time, kAlloc allocator);

/**
 * Adds sensor data (contained in a GoWebScanCalInputItem object) to the tile.
 * 
 * @public          @memberof GoWebScanCalInputTile
 * @param   tile    GoWebScanCalInputTile object.
 * @param   item    Input item.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputTile_AddItem(GoWebScanCalInputTile tile, GoWebScanCalInputItem* item);

/**
* Removes sensor data (contained in a GoWebScanCalInputItem object) from the tile.
* 
* @public          @memberof GoWebScanCalInputTile
* @param   tile    GoWebScanCalInputTile object.
* @param   item    Pointer to the removed input item.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanCalInputTile_RemoveItem(GoWebScanCalInputTile tile, GoWebScanCalInputItem* item);

/**
 * Gets the number of message items in the tile.
 * 
 * @public          @memberof GoWebScanCalInputTile
 * @param   tile    GoWebScanCalInputTile object.
 * @return          Item count.
 */
GoWebScanFx(kSize) GoWebScanCalInputTile_ItemCount(GoWebScanCalInputTile tile);

/**
 * Gets the message item at a specific index in the tile.
 * 
 * @public          @memberof GoWebScanCalInputTile
 * @param   tile    GoWebScanCalInputTile object.
 * @param   index   Item index.
 * @return          GoWebScanCalInputItem object representing the message.
 */
GoWebScanFx(GoWebScanCalInputItem) GoWebScanCalInputTile_ItemAt(GoWebScanCalInputTile tile, kSize index);

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

/**
* Gets the timestamp of the tile in microseconds.
* 
* @public          @memberof GoWebScanCalInputTile
* @param   tile    GoWebScanCalInputTile object.
* @return          Time of tile (microseconds).
*/
GoWebScanFx(k64s) GoWebScanCalInputTile_Time(GoWebScanCalInputTile tile);

#include <GoWebScanSdk/GoWebScanCalInputTile.x.h>

#endif