GoWebScanCalMsg.h

Go to the documentation of this file.

/**
* @file    GoWebScanCalMsg.h
* @brief   Declares a GoWebScanCalMsg object.
*
* @internal
* Copyright (C) 2017-2021 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/
#ifndef GO_SCANNER_CAL_MSG_H
#define GO_SCANNER_CAL_MSG_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @struct  GoWebScanCalMsgAttr
* @extends kValue
* @ingroup GoWebScanSdk-Messages
* @brief   Represents the attributes of a calibration message
*/
typedef struct GoWebScanCalMsgAttr
{
    k64s deviceId;                              ///< Id of station device sending this message
    GoWebScanCalStatus result;                  ///< Calibration result
    k64s yReference;                            ///< Calibration y-reference for this system (mils).
    k64s xReference;                            ///< Calibration x-reference for this system (mils).    
} GoWebScanCalMsgAttr;

/**
* @struct  GoWebScanCalMsgAttr
* @extends kValue
* @ingroup GoWebScanSdk-Messages
* @brief   Represents an issue that occurred during calibration processing
*/
typedef struct GoWebScanCalMsgIssue
{
    GoWebScanSystemPlane groupId;               ///< Group identifier (0-Top, 1-Bottom).
    k64s columnId;                              ///< Camera location in group (index).
    k64s deviceId;                              ///< Profile Sensor identifier (serial number).
    k64s bankId;                                ///< Camera location in sensor (0-Left, 1-Right).
    GoWebScanDataSource sourceType;             ///< Data type (0-Profile, 1-Vision, 2-Tracheid).
    k64s x0;                                    ///< Left x-coordinate for this issue (mils).
    k64s x1;                                    ///< Right x-coordinate for this issue (mils).
    GoWebScanCalActivity activity;              ///< Calibration activity associated with issue.
    GoWebScanCalNodeStatus status;              ///< Calibration issue type.
} GoWebScanCalMsgIssue;

/**
* @class   GoWebScanCalMsg
* @extends kObject
* @ingroup GoWebScanSdk-Messages
* @brief   Represents a message containing issues that occurred during system calibration. Each issue is associated
*          with a node in the system, a data source (profile, tracheid, or vision), and a stage of the calibration
*          processing.    
*/
typedef kObject GoWebScanCalMsg;

/**
* Constructs a GoWebScanCalMsg object.
*
* @public                   @memberof GoWebScanCalMsg
* @param  msg               Receives the constructed GoWebScanCalMsg object. 
* @param  issueCount        Number of calibration issues to contain in this message 
* @param  allocator         Memory allocator (or kNULL for default). 
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanCalMsg_Construct(GoWebScanCalMsg* msg, kSize issueCount, kAlloc allocator);

/**
* Gets the attributes of a message.
*
* @public                   @memberof GoWebScanCalMsg
* @param  msg               GoWebScanCalMsg object. 
* @return                   Message attributes.
*/
GoWebScanFx(GoWebScanCalMsgAttr*) GoWebScanCalMsg_Attributes(GoWebScanCalMsg msg); 

/**
* Gets the number of calibration issues in the message.
*
* @public                   @memberof GoWebScanCalMsg
* @param  msg               GoWebScanCalMsg object. 
* @return                   Issue count.
*/
GoWebScanFx(kSize) GoWebScanCalMsg_IssueCount(GoWebScanCalMsg msg); 

/**
* Gets the calibration issue at a specified index.
*
* @public                   @memberof GoWebScanCalMsg
* @param  msg               GoWebScanCalMsg object. 
* @param  index             Index of issue.
* @return                   Calibration issue.
*/
GoWebScanFx(GoWebScanCalMsgIssue*) GoWebScanCalMsg_IssueAt(GoWebScanCalMsg msg, kSize index); 

#include <GoWebScanSdk/GoWebScanCalMsg.x.h>

#endif