GoWebScanProfileTileMsg.h

Go to the documentation of this file.

/**
* @file    GoWebScanProfileTileMsg.h
* @brief   Declares a GoWebScanProfileTileMsg 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_SCANNER_PROFILE_TILE_MSG_H
#define GO_SCANNER_PROFILE_TILE_MSG_H

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

/**
* @class   GoWebScanProfileTileMsg
* @extends GoWebScanPipeMsg
* @ingroup GoWebScanSdk-Messages
* @brief   Represents a message containing a tile of X and Y resampled profile Z data. This
*          message can be used to represent data from a single node in the system, data
*          from a plane in the system (after merging resampled data from all nodes in a plane),
*          or data from a detected board.
*         
*/
typedef GoWebScanPipeMsg GoWebScanProfileTileMsg;

/**
* Constructs a GoWebScanProfileTileMsg object.
*
* @public                   @memberof GoWebScanProfileTileMsg
* @param  msg               Receives the constructed GoWebScanProfileTileMsg object. 
* @param  count             Length of tile in Y-axis (pixels).
* @param  width             Length of tile in X-axis (pixels).
* @param  pool              Message pool of GoWebScanProfileTileMsg objects
* @param  allocator         Memory allocator (or kNULL for default). 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanProfileTileMsg_Construct(GoWebScanProfileTileMsg* msg, kSize count, kSize width, GoWebScanPipeMsgPool pool, kAlloc allocator);

/**
* Destroys a GoWebScanProfileTileMsg object.
*
* @public                   @memberof GoWebScanProfileTileMsg
* @param  msg               GoWebScanProfileTileMsg object. 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanProfileTileMsg_Destroy(GoWebScanProfileTileMsg msg);

/**
* Resizes a GoWebScanProfileTileMsg object.
*
* @public                   @memberof GoWebScanProfileTileMsg
* @param  msg               GoWebScanProfileTileMsg object. 
* @param  count             Length of tile in Y-axis (pixels).
* @param  width             Length of tile in X-axis (pixels).
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanProfileTileMsg_Resize(GoWebScanProfileTileMsg msg, kSize count, kSize width);

/**
* Gets the size, in bytes, of the message data buffer.
*
* @public                   @memberof GoWebScanProfileTileMsg
* @param  msg               GoWebScanProfileTileMsg object. 
* @return                   Message data buffer size (bytes).
*/
GoWebScanFx(kSize) GoWebScanProfileTileMsg_Size(GoWebScanProfileTileMsg msg);

/**
* Gets length of the tile in the Y-axis (pixels).
*
* @public                   @memberof GoWebScanProfileTileMsg
* @param  msg               GoWebScanProfileTileMsg object. 
* @return                   Message count.
*/
GoWebScanFx(kSize) GoWebScanProfileTileMsg_Count(GoWebScanProfileTileMsg msg);

/**
* Gets length of the tile in the X-axis (pixels).
*
* @public                   @memberof GoWebScanProfileTileMsg
* @param  msg               GoWebScanProfileTileMsg object. 
* @return                   Message width.
*/
GoWebScanFx(kSize) GoWebScanProfileTileMsg_Width(GoWebScanProfileTileMsg msg);

/**
* Gets the inputs corresponding to each row of the tile.
*
* @public                   @memberof GoWebScanProfileTileMsg
* @param  msg               GoWebScanProfileTileMsg object. 
* @return                   Array of inputs. Type k64s.
*/
GoWebScanFx(kArray1) GoWebScanProfileTileMsg_Inputs(GoWebScanProfileTileMsg msg);

/**
* Gets the input at a specified row.
*
* @public                   @memberof GoWebScanProfileTileMsg
* @param  msg               GoWebScanProfileTileMsg object. 
* @param  rowIndex          Row index.
* @return                   Input at specified row.
*/
GoWebScanFx(k64s*) GoWebScanProfileTileMsg_InputsAt(GoWebScanProfileTileMsg msg, kSize rowIndex);

/**
* Gets the tile data array.
*
* @public                   @memberof GoWebScanProfileTileMsg
* @param  msg               GoWebScanProfileTileMsg object. 
* @return                   Message data array. Type k16s.
*/
GoWebScanFx(kArray2) GoWebScanProfileTileMsg_Data(GoWebScanProfileTileMsg msg);

/**
* Gets a pointer to the start of a tile row.
*
* @public                   @memberof GoWebScanProfileTileMsg
* @param  msg               GoWebScanProfileTileMsg object. 
* @param  rowIndex          Row index.
* @return                   Pointer to start of row.
*/
GoWebScanFx(k16s*) GoWebScanProfileTileMsg_DataAt(GoWebScanProfileTileMsg msg, kSize rowIndex);

#include <GoWebScanSdk/GoWebScanProfileTileMsg.x.h>

#endif