GoWebScanTracheidWebMsg.h

Go to the documentation of this file.

/**
* @file    GoWebScanTracheidWebMsg.h
* @brief   Declares a GoWebScanTracheidWebMsg 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_TRACHEID_WEB_MSG_H
#define GO_SCANNER_TRACHEID_WEB_MSG_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @struct  GoWebScanTracheidWebMsgAttr
* @extends kValue
* @ingroup GoWebScanSdk-Messages
* @brief   Represents the attributes of a tracheid web message
*/
typedef struct GoWebScanTracheidWebMsgAttr
{
    k64s deviceId;                                  ///< Id of station device sending this message
    k64s groupId;                                   ///< Group identifier: Top (0), or Bottom (1)
    k64s sectionId;                                 ///< Section identifier (from GoWebScanSettings Section/Id)
    k64s sequenceIndex;                             ///< Tile id; increases with each unique tile
    k64s timestamp;                                 ///< Capture time
    k64s encoder;                                   ///< Capture position (encoder ticks)
    k64s yOrigin;                                   ///< Section y-location (mils)
    k64s xOrigin;                                   ///< Section x-location (from GoWebScanSettings Section/X0)
    k64s yResolution;                               ///< Pixel height (mils)
    k64s xResolution;                               ///< Pixel width (mils)
} GoWebScanTracheidWebMsgAttr;

/**
* @class   GoWebScanTracheidWebMsg
* @extends kObject
* @ingroup GoWebScanSdk-Messages
* @brief   Represents a message containing a tile of resampled and merged spot angle,
*          scatter, and area data for a given section.
*/
typedef kObject GoWebScanTracheidWebMsg;

/**
* Constructs a GoWebScanTracheidWebMsg msg.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               Receives the constructed GoWebScanTracheidWebMsg msg. 
* @param  height            Height of the tile data array contained in the message.
* @param  width             Width of the tile data array contained in the message.
* @param  allocator         Memory allocator (or kNULL for default). 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanTracheidWebMsg_Construct(GoWebScanTracheidWebMsg* msg, kSize height, kSize width, kAlloc allocator);

/**
* Resize a GoWebScanTracheidWebMsg msg.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               GoWebScanTracheidWebMsg msg. 
* @param  height            New height.
* @param  width             New width.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanTracheidWebMsg_Realloc(GoWebScanTracheidWebMsg msg, kSize height, kSize width);

/**
* Gets the height of a message.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               GoWebScanTracheidWebMsg msg. 
* @return                   Message height.
*/
GoWebScanFx(kSize) GoWebScanTracheidWebMsg_Height(GoWebScanTracheidWebMsg msg);

/**
* Gets the width of a message.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               GoWebScanTracheidWebMsg msg. 
* @return                   Message width.
*/
GoWebScanFx(kSize) GoWebScanTracheidWebMsg_Width(GoWebScanTracheidWebMsg msg);

/**
* Gets the attributes of a message.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               GoWebScanTracheidWebMsg msg. 
* @return                   Message attributes.
*/
GoWebScanFx(GoWebScanTracheidWebMsgAttr*) GoWebScanTracheidWebMsg_Attributes(GoWebScanTracheidWebMsg msg);

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

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

/**
* Gets the tile angle data array.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               GoWebScanTracheidWebMsg msg. 
* @return                   Message angle data array. Type k8u.
*/
GoWebScanFx(kArray2) GoWebScanTracheidWebMsg_Angle(GoWebScanTracheidWebMsg msg);

/**
* Gets a pointer to the angle value at a specified row and column index.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               GoWebScanTracheidWebMsg msg. 
* @param  rowIndex          Row index (Y-axis). 
* @param  colIndex          Column index (X-axis).
* @return                   Pointer to angle value.
*/
GoWebScanFx(k8u*) GoWebScanTracheidWebMsg_AngleAt(GoWebScanTracheidWebMsg msg, kSize rowIndex, kSize colIndex);

/**
* Gets the tile scatter data array.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               GoWebScanTracheidWebMsg msg. 
* @return                   Message scatter data array. Type k8u.
*/
GoWebScanFx(kArray2) GoWebScanTracheidWebMsg_Scatter(GoWebScanTracheidWebMsg msg);

/**
* Gets a pointer to the scatter value at a specified row and column index.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               GoWebScanTracheidWebMsg msg. 
* @param  rowIndex          Row index (Y-axis). 
* @param  colIndex          Column index (X-axis).
* @return                   Pointer to scatter value.
*/
GoWebScanFx(k8u*) GoWebScanTracheidWebMsg_ScatterAt(GoWebScanTracheidWebMsg msg, kSize rowIndex, kSize colIndex);

/**
* Gets the tile area data array.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               GoWebScanTracheidWebMsg msg. 
* @return                   Message area data array. Type k8u.
*/
GoWebScanFx(kArray2) GoWebScanTracheidWebMsg_Area(GoWebScanTracheidWebMsg msg);

/**
* Gets a pointer to the area value at a specified row and column index.
*
* @public                   @memberof GoWebScanTracheidWebMsg
* @param  msg               GoWebScanTracheidWebMsg msg. 
* @param  rowIndex          Row index (Y-axis). 
* @param  colIndex          Column index (X-axis).
* @return                   Pointer to area value.
*/
GoWebScanFx(k8u*) GoWebScanTracheidWebMsg_AreaAt(GoWebScanTracheidWebMsg msg, kSize rowIndex, kSize colIndex);

#include <GoWebScanSdk/GoWebScanTracheidWebMsg.x.h>

#endif