GoWebScanSystemMsg.h

Go to the documentation of this file.

/**
* @file    GoWebScanSystemMsg.h
* @brief   Declares a GoWebScanSystemMsg 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_SYSTEM_MSG_H
#define GO_SCANNER_SYSTEM_MSG_H

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

/**
* @class   GoWebScanSystemMsg
* @extends GoWebScanPipeMsg
* @ingroup GoWebScanSdk-Messages
* @brief   Represents a container of GoWebScanPipeMsg tile messages of each tile type (profile, tracheid, 
*          and vision) and each system plane (top and bottom). This message is used to contain the 
*          X and Y-axis matched tile output of merging, and also of board detection (where the tiles 
*          represent a detected board).
*/
typedef GoWebScanPipeMsg GoWebScanSystemMsg;

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

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

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

/**
* Recycles all messages contained in the system message.
*
* @public                   @memberof GoWebScanSystemMsg
* @param  msg               GoWebScanSystemMsg object. 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSystemMsg_Clear(GoWebScanSystemMsg msg);

/**
* Adds a tile message to the system message.
*
* @public                   @memberof GoWebScanSystemMsg
* @param  msg               GoWebScanSystemMsg object. 
* @param  id                Tile type (profile, tracheid, or vision). 
* @param  plane             System plane of tile. 
* @param  tile              Tile message to add. 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSystemMsg_SetTile(GoWebScanSystemMsg msg, GoWebScanPlaneTileId id, GoWebScanSystemPlane plane, GoWebScanPipeMsg tile);

/**
* Gets the tile message of a specified type and plane.
*
* @public                   @memberof GoWebScanSystemMsg
* @param  msg               GoWebScanSystemMsg object. 
* @param  id                Tile type (profile, tracheid, or vision). 
* @param  plane             System plane of tile. 
* @return                   Tile message.
*/
GoWebScanFx(GoWebScanPipeMsg) GoWebScanSystemMsg_TileAt(GoWebScanSystemMsg msg, GoWebScanPlaneTileId id, GoWebScanSystemPlane plane);

#include <GoWebScanSdk/GoWebScanSystemMsg.x.h>

#endif