GoWebScanVisionBoardMsg.h

Go to the documentation of this file.

/**
* @file    GoWebScanVisionBoardMsg.h
* @brief   Declares a GoWebScanVisionBoardMsg 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_VISION_BOARD_MSG_H
#define GO_SCANNER_VISION_BOARD_MSG_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @struct  GoWebScanVisionBoardMsgAttr
* @extends kValue
* @ingroup GoWebScanSdk-Messages
* @brief   Represents the attributes of a vision board message
*/
typedef struct GoWebScanVisionBoardMsgAttr
{
    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;                             ///< Board id; increases with each unique board.
    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)
} GoWebScanVisionBoardMsgAttr;

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

/**
* Constructs a GoWebScanVisionBoardMsg board.
*
* @public                   @memberof GoWebScanVisionBoardMsg
* @param  msg               Receives the constructed GoWebScanVisionBoardMsg object. 
* @param  pixelType         Pixel type of the board data array contained in the message.
* @param  height            Height of the board data array contained in the message.
* @param  width             Width of the board data array contained in the message.
* @param  allocator         Memory allocator (or kNULL for default). 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanVisionBoardMsg_Construct(GoWebScanVisionBoardMsg* msg, kType pixelType, kSize height, kSize width, kAlloc allocator);

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

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

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

/**
* Gets the pixel type of a message.
*
* @public                   @memberof GoWebScanVisionBoardMsg
* @param  msg               GoWebScanVisionBoardMsg object. 
* @return                   Message pixel type.
*/
GoWebScanFx(kType) GoWebScanVisionBoardMsg_PixelType(GoWebScanVisionBoardMsg msg);

/**
* Gets the attributes of a message.
*
* @public                   @memberof GoWebScanVisionBoardMsg
* @param  msg               GoWebScanVisionBoardMsg object. 
* @return                   Message attributes.
*/
GoWebScanFx(GoWebScanVisionBoardMsgAttr*) GoWebScanVisionBoardMsg_Attributes(GoWebScanVisionBoardMsg msg);

/**
* Gets the board data array.
*
* @public                   @memberof GoWebScanVisionBoardMsg
* @param  msg               GoWebScanVisionBoardMsg object. 
* @return                   Data array containing board. Type pixelType used to construct board.
*/
GoWebScanFx(kArray2) GoWebScanVisionBoardMsg_Data(GoWebScanVisionBoardMsg msg);

/**
* Gets the pixel value at a specified row and column in the board array.
*
* @public                   @memberof GoWebScanVisionBoardMsg
* @param  msg               GoWebScanVisionBoardMsg object. 
* @param  rowIndex          Row index (Y-axis). 
* @param  colIndex          Column index (X-axis).
* @return                   Pointer to pixel value (of same type as pixelType parameter in object construction).
*/
GoWebScanFx(kPointer) GoWebScanVisionBoardMsg_DataAt(GoWebScanVisionBoardMsg msg, kSize rowIndex, kSize colIndex);

#include <GoWebScanSdk/GoWebScanVisionBoardMsg.x.h>

#endif