GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanCalMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanCalMsg.h
3 * @brief Declares a GoWebScanCalMsg object.
4 *
5 * @internal
6 * Copyright (C) 2017-2018 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SCANNER_CAL_MSG_H
11 #define GO_SCANNER_CAL_MSG_H
12 
14 
15 kBeginHeader()
16 
17 /**
18 * @struct GoWebScanCalMsgAttr
19 * @extends kValue
20 * @ingroup GoWebScanSdk-Messages
21 * @brief Represents the attributes of a calibration message
22 */
23 typedef struct GoWebScanCalMsgAttr
24 {
25  k64s deviceId; ///< Id of station device sending this message
26  GoWebScanCalStatus result; ///< Calibration result
27  k64s yReference; ///< Calibration y-reference for this system (mils).
28  k64s xReference; ///< Calibration x-reference for this system (mils).
30 
31 /**
32 * @struct GoWebScanCalMsgAttr
33 * @extends kValue
34 * @ingroup GoWebScanSdk-Messages
35 * @brief Represents an issue that occurred during calibration processing
36 */
37 typedef struct GoWebScanCalMsgIssue
38 {
39  GoWebScanSystemPlane groupId; ///< Group identifier (0-Top, 1-Bottom).
40  k64s columnId; ///< Camera location in group (index).
41  k64s deviceId; ///< Profile Sensor identifier (serial number).
42  k64s bankId; ///< Camera location in sensor (0-Left, 1-Right).
43  GoWebScanDataSource sourceType; ///< Data type (0-Profile, 1-Vision, 2-Tracheid).
44  k64s x0; ///< Left x-coordinate for this issue (mils).
45  k64s x1; ///< Right x-coordinate for this issue (mils).
46  GoWebScanCalActivity activity; ///< Calibration activity associated with issue.
47  GoWebScanCalNodeStatus status; ///< Calibration issue type.
48 } GoWebScanCalMsgIssue;
49 
50 /**
51 * @class GoWebScanCalMsg
52 * @extends kObject
53 * @ingroup GoWebScanSdk-Messages
54 * @brief Represents a message containing issues that occurred during system calibration. Each issue is associated
55 * with a node in the system, a data source (profile, tracheid, or vision), and a stage of the calibration
56 * processing.
57 */
58 typedef kObject GoWebScanCalMsg;
59 
60 /**
61 * Constructs a GoWebScanCalMsg object.
62 *
63 * @public @memberof GoWebScanCalMsg
64 * @param msg Receives the constructed GoWebScanCalMsg object.
65 * @param issueCount Number of calibration issues to contain in this message
66 * @param allocator Memory allocator (or kNULL for default).
67 * @return Operation status.
68 */
69 GoWebScanFx(kStatus) GoWebScanCalMsg_Construct(GoWebScanCalMsg* msg, kSize issueCount, kAlloc allocator);
70 
71 /**
72 * Gets the attributes of a message.
73 *
74 * @public @memberof GoWebScanCalMsg
75 * @param msg GoWebScanCalMsg object.
76 * @return Message attributes.
77 */
79 
80 /**
81 * Gets the number of calibration issues in the message.
82 *
83 * @public @memberof GoWebScanCalMsg
84 * @param msg GoWebScanCalMsg object.
85 * @return Issue count.
86 */
88 
89 /**
90 * Gets the calibration issue at a specified index.
91 *
92 * @public @memberof GoWebScanCalMsg
93 * @param msg GoWebScanCalMsg object.
94 * @param index Index of issue.
95 * @return Calibration issue.
96 */
97 GoWebScanFx(GoWebScanCalMsgIssue*) GoWebScanCalMsg_IssueAt(GoWebScanCalMsg msg, kSize index);
98 
99 kEndHeader()
100 #include <GoWebScanSdk/GoWebScanCalMsg.x.h>
101 
102 #endif
103 
GoWebScanCalMsgIssue * GoWebScanCalMsg_IssueAt(GoWebScanCalMsg msg, kSize index)
Gets the calibration issue at a specified index.
Represents a type of error or warning that occurred during system calibration processing of a node...
Represents a type of sensor data.
GoWebScanCalMsgAttr * GoWebScanCalMsg_Attributes(GoWebScanCalMsg msg)
Gets the attributes of a message.
Represents a message containing issues that occurred during system calibration. Each issue is associa...
Essential GoWebScan declarations.
Represents a stage or activity in the system calibration processing pipeline.
kSize GoWebScanCalMsg_IssueCount(GoWebScanCalMsg msg)
Gets the number of calibration issues in the message.
GoWebScanCalStatus result
Calibration result.
Definition: GoWebScanCalMsg.h:26
k64s yReference
Calibration y-reference for this system (mils).
Definition: GoWebScanCalMsg.h:27
Represents the top or bottom plane of the system.
k64s xReference
Calibration x-reference for this system (mils).
Definition: GoWebScanCalMsg.h:28
Represents the attributes of a calibration message.
Definition: GoWebScanCalMsg.h:23
Represents the status of calibration processing for the system.
kStatus GoWebScanCalMsg_Construct(GoWebScanCalMsg *msg, kSize issueCount, kAlloc allocator)
Constructs a GoWebScanCalMsg object.
k64s deviceId
Id of station device sending this message.
Definition: GoWebScanCalMsg.h:25