GoWebScanTracheidInputMsg.h

Go to the documentation of this file.

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

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

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

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

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

/**
 * Imports a GoTracheidMsg into a GoWebScanTracheidInputMsg object. The tracheid message needs
 * to matched to a profile message with the closest frame number in order to import spot X data.
 * Since the tracheid and profile messages contains batched data, the tracheid message may
 * overlap with two profile messages. The messages are cloned into internal objects. As such,
 * the GoProfilePointCloudMsg and GoTracheidMsg objects are still owned by the calling function 
 * and must be destroyed by it.
 *  
 * @public                      @memberof GoWebScanTracheidInputMsg
 * @param   msg                 GoWebScanTracheidInputMsg object.
 * @param   deviceId            Serial number of device from which tracheid message originates.
 * @param   tracheidStampMsg    Tracheid message stamp.
 * @param   tracheidMsg         Tracheid message.
 * @param   profileStampMsg0    Stamp of first matching candidate profile message.
 * @param   profileMsg0         First matching candidate profile message.
 * @param   profileStampMsg1    Stamp of second matching candidate profile message.
 * @param   profileMsg1         Second matching candidate profile message.
 * @param   config              System configuration.
 * @return                      Operation status.
 */
GoWebScanFx(kStatus) GoWebScanTracheidInputMsg_Import(GoWebScanTracheidInputMsg msg, k32s deviceId, GoStampMsg tracheidStampMsg, GoTracheidMsg tracheidMsg,
    GoStampMsg profileStampMsg0, GoProfilePointCloudMsg profileMsg0, GoStampMsg profileStampMsg1, GoProfilePointCloudMsg profileMsg1, GoWebScanConfig config);

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

/**
* Gets the count of tracheid arrays in this message.
*
* @public                   @memberof GoWebScanTracheidInputMsg
* @param  msg               GoWebScanTracheidInputMsg object. 
* @return                   Tracheid array count.
*/
GoWebScanFx(kSize) GoWebScanTracheidInputMsg_Count(GoWebScanTracheidInputMsg msg);

/**
* Gets the width of tracheid arrays in this message
*
* @public                   @memberof GoWebScanTracheidInputMsg
* @param  msg               GoWebScanTracheidInputMsg object. 
* @return                   Tracheid array width.
*/
GoWebScanFx(kSize) GoWebScanTracheidInputMsg_Width(GoWebScanTracheidInputMsg msg);

/**
* Gets a pointer to the message attributes for a tracheid array.
*
* @public                   @memberof GoWebScanTracheidInputMsg
* @param  msg               GoWebScanTracheidInputMsg object. 
* @param  rowIndex          Tracheid message index.
* @return                   Pointer to tracheid message attributes.
*/
GoWebScanFx(GoWebScanInputAttr*) GoWebScanTracheidInputMsg_AttrAt(GoWebScanTracheidInputMsg msg, kSize rowIndex);

/**
* Gets a pointer to the start of a tracheid array at a given index.
*
* @public                   @memberof GoWebScanTracheidInputMsg
* @param  msg               GoWebScanTracheidInputMsg object. 
* @param  rowIndex          Tracheid message index.
* @return                   Pointer to tracheid array.
*/
GoWebScanFx(GoWebScanTracheidPoint*) GoWebScanTracheidInputMsg_DataAt(GoWebScanTracheidInputMsg msg, kSize rowIndex);

#include <GoWebScanSdk/GoWebScanTracheidInputMsg.x.h>

#endif