GoWebScanVisionInputMsg.h

Go to the documentation of this file.

/**
* @file    GoWebScanVisionInputMsg.h
* @brief   Declares a GoWebScanVisionInputMsg 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_INPUT_MSG_H
#define GO_SCANNER_VISION_INPUT_MSG_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanPipeMsg.h>
#include <GoWebScanSdk/GoWebScanConfig.h>
#include <GoWebScanSdk/GoWebScanConfigNode.h>
#include <GoSdk/GoSdk.h>

/**
* @class   GoWebScanVisionInputMsg
* @extends GoWebScanPipeMsg
* @ingroup GoWebScanSdk-Messages
* @brief   Represents a message containing a raw vision message from a sensor.
*/
typedef GoWebScanPipeMsg GoWebScanVisionInputMsg;

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

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

/**
* Imports a GoVideoMsg msg into a GoWebScanVisionInputMsg object. The messages are cloned into
* internal objects. As such, the GoVideoMsg object is still owned by the calling function and
* must be destroyed by it.
*
* @public                   @memberof GoWebScanVisionInputMsg
* @param  msg               GoWebScanVisionInputMsg object. 
* @param  deviceId          Serial number of device from which message originates.
* @param  stampMsg          Message stamp.
* @param  visionMsg         Video message.
* @param  configNode        Node configuration.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanVisionInputMsg_Import(GoWebScanVisionInputMsg msg, k32s deviceId, GoStampMsg stampMsg, GoVideoMsg visionMsg, GoWebScanConfigNode configNode);

/**
* Gets the size, in bytes, of the vision data buffer.
*
* @public                   @memberof GoWebScanVisionInputMsg
* @param  msg               GoWebScanVisionInputMsg object. 
* @return                   Buffer size (bytes).
*/
GoWebScanFx(kSize) GoWebScanVisionInputMsg_Size(GoWebScanVisionInputMsg msg);

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

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

/**
* Gets the image stored in the message.
*
* @public                   @memberof GoWebScanVisionInputMsg
* @param  msg               GoWebScanVisionInputMsg object. 
* @return                   Message image.
*/
GoWebScanFx(kImage) GoWebScanVisionInputMsg_Data(GoWebScanVisionInputMsg msg);

/**
* Gets a pointer to the start of an image row.
*
* @public                   @memberof GoWebScanVisionInputMsg
* @param  msg               GoWebScanVisionInputMsg object. 
* @param  index             Row index.
* @return                   Pointer to start of image row.
*/
GoWebScanFx(k8u*) GoWebScanVisionInputMsg_DataAt(GoWebScanVisionInputMsg msg, kSize index);

#include <GoWebScanSdk/GoWebScanVisionInputMsg.x.h>

#endif