GoWebScanTileListMsg.h

Go to the documentation of this file.

/**
* @file    GoWebScanTileListMsg.h
* @brief   Declares a GoWebScanTileListMsg 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_TILE_LIST_MSG_H
#define GO_SCANNER_TILE_LIST_MSG_H

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

/**
* @class   GoWebScanTileListMsg
* @extends GoWebScanPipeMsg
* @ingroup GoWebScanSdk-Messages
* @brief   Represents a list of tiles (of the same type and plane) that are matched by Y-position.
*          This message type contains data after synchronization and prior to merging.
*/
typedef GoWebScanPipeMsg GoWebScanTileListMsg;

/**
* Constructs a GoWebScanTileListMsg object.
*
* @public                   @memberof GoWebScanTileListMsg
* @param  msg               Receives the constructed GoWebScanTileListMsg object. 
* @param  pool              Message pool of GoWebScanTileListMsg objects
* @param  allocator         Memory allocator (or kNULL for default). 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanTileListMsg_Construct(GoWebScanTileListMsg* msg, GoWebScanPipeMsgPool pool, kAlloc allocator);

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

/**
* Adds a tile to the list.
*
* @public                   @memberof GoWebScanTileListMsg
* @param  msg               GoWebScanTileListMsg object. 
* @param  tile              Tile message to add.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanTileListMsg_Add(GoWebScanTileListMsg msg, GoWebScanPipeMsg tile);

/**
* Recycles all tiles contained in the list.
*
* @public                   @memberof GoWebScanTileListMsg
* @param  msg               GoWebScanTileListMsg object. 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanTileListMsg_Clear(GoWebScanTileListMsg msg);

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

/**
* Gets the count of tiles in the list.
*
* @public                   @memberof GoWebScanTileListMsg
* @param  msg               GoWebScanTileListMsg object. 
* @return                   Message count.
*/
GoWebScanFx(kSize) GoWebScanTileListMsg_Count(GoWebScanTileListMsg msg);

/**
* Gets the tile message of a specified index of the list.
*
* @public                   @memberof GoWebScanTileListMsg
* @param  msg               GoWebScanTileListMsg object. 
* @param  index             Tile index. 
* @return                   Tile message.
*/
GoWebScanFx(GoWebScanPipeMsg) GoWebScanTileListMsg_At(GoWebScanTileListMsg msg, kSize index);

#include <GoWebScanSdk/GoWebScanTileListMsg.x.h>

#endif