GoWebScanProfileWebMsg.h

Go to the documentation of this file.

/**
* @file    GoWebScanProfileWebMsg.h
* @brief   Declares a GoWebScanProfileWebMsg 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_WEB_MSG_H
#define GO_SCANNER_PROFILE_WEB_MSG_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @struct  GoWebScanProfileWebMsgAttr
* @extends kValue
* @ingroup GoWebScanSdk-Messages
* @brief   Represents the attributes of a profile web message
*/
typedef struct GoWebScanProfileWebMsgAttr
{
    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)
} GoWebScanProfileWebMsgAttr;

/**
* @class   GoWebScanProfileWebMsg
* @extends kObject
* @ingroup GoWebScanSdk-Messages
* @brief   Represents a message containing a tile of resampled and merged geometric data for a
*          given section.
*/
typedef kObject GoWebScanProfileWebMsg;

/**
* Constructs a GoWebScanProfileWebMsg msg.
*
* @public                   @memberof GoWebScanProfileWebMsg
* @param  msg               Receives the constructed GoWebScanProfileWebMsg 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) GoWebScanProfileWebMsg_Construct(GoWebScanProfileWebMsg* msg, kSize height, kSize width, kAlloc allocator);

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

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

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

/**
* Gets the attributes of a message.
*
* @public                   @memberof GoWebScanProfileWebMsg
* @param  msg               GoWebScanProfileWebMsg msg. 
* @return                   Message attributes.
*/
GoWebScanFx(GoWebScanProfileWebMsgAttr*) GoWebScanProfileWebMsg_Attributes(GoWebScanProfileWebMsg msg);

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

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

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

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

#include <GoWebScanSdk/GoWebScanProfileWebMsg.x.h>

#endif