GoWebScanProfileInputMsg.h

Go to the documentation of this file.

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

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

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

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

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

/**
 * Imports a GoProfilePointCloudMsg msg into a GoWebScanProfileInputMsg object. The messages are 
 * cloned into internal objects. As such, the GoProfilePointCloudMsg object is still owned by the 
 * calling function and must be destroyed by it.
 * 
 * @public              @memberof GoWebScanProfileInputMsg
 * @param   msg         GoWebScanProfileInputMsg object.
 * @param   deviceId    Serial number of device from which message originates.
 * @param   stampMsg    Message stamp.
 * @param   profileMsg  Profile message.
 * @param   config      System configuration.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanProfileInputMsg_Import(GoWebScanProfileInputMsg msg, k32s deviceId, GoStampMsg stampMsg, GoProfilePointCloudMsg profileMsg, GoWebScanConfig config);

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

/**
* Gets the count of profile arrays in this message.
*
* @public                   @memberof GoWebScanProfileInputMsg
* @param  msg               GoWebScanProfileInputMsg object. 
* @return                   Profile array count.
*/
GoWebScanFx(kSize) GoWebScanProfileInputMsg_Count(GoWebScanProfileInputMsg msg);

/**
* Gets the width of profile arrays in this message
*
* @public                   @memberof GoWebScanProfileInputMsg
* @param  msg               GoWebScanProfileInputMsg object. 
* @return                   Profile array width.
*/
GoWebScanFx(kSize) GoWebScanProfileInputMsg_Width(GoWebScanProfileInputMsg msg);

/**
* Gets a pointer to the message attributes for a profile array.
*
* @public                   @memberof GoWebScanProfileInputMsg
* @param  msg               GoWebScanProfileInputMsg object. 
* @param  rowIndex          Profile message index.
* @return                   Pointer to profile message attributes.
*/
GoWebScanFx(GoWebScanInputAttr*) GoWebScanProfileInputMsg_AttrAt(GoWebScanProfileInputMsg msg, kSize rowIndex);

/**
* Gets a pointer to the start of a profile array at a given index.
*
* @public                   @memberof GoWebScanProfileInputMsg
* @param  msg               GoWebScanProfileInputMsg object. 
* @param  rowIndex          Profile message index.
* @return                   Pointer to profile array.
*/
GoWebScanFx(kPoint16s*) GoWebScanProfileInputMsg_DataAt(GoWebScanProfileInputMsg msg, kSize rowIndex);

#include <GoWebScanSdk/GoWebScanProfileInputMsg.x.h>

#endif