GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanTracheidBoardMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanTracheidBoardMsg.h
3 * @brief Declares a GoWebScanTracheidBoardMsg 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_TRACHEID_BOARD_MSG_H
11 #define GO_SCANNER_TRACHEID_BOARD_MSG_H
12 
14 
15 kBeginHeader()
16 
17 /**
18 * @struct GoWebScanTracheidBoardMsgAttr
19 * @extends kValue
20 * @ingroup GoWebScanSdk-Messages
21 * @brief Represents the attributes of a tracheid board message
22 */
24 {
25  k64s deviceId; ///< Id of station device sending this message
26  k64s groupId; ///< Group identifier: Top (0), or Bottom (1)
27  k64s sectionId; ///< Section identifier (from GoWebScanSettings Section/Id)
28  k64s sequenceIndex; ///< Board id; increases with each unique board.
29  k64s timestamp; ///< Capture time
30  k64s encoder; ///< Capture position (encoder ticks)
31  k64s yOrigin; ///< Section y-location (mils)
32  k64s xOrigin; ///< Section x-location (from GoWebScanSettings Section/X0)
33  k64s yResolution; ///< Pixel height (mils)
34  k64s xResolution; ///< Pixel width (mils)
36 
37 /**
38 * @class GoWebScanTracheidBoardMsg
39 * @extends kObject
40 * @ingroup GoWebScanSdk-Messages
41 * @brief Represents a message containing spot angle, scatter ratio, and area measurements from a detected board
42 * for a given section.
43 */
45 
46 /**
47 * Constructs a GoWebScanTracheidBoardMsg object.
48 *
49 * @public @memberof GoWebScanTracheidBoardMsg
50 * @param msg Receives the constructed GoWebScanTracheidBoardMsg object.
51 * @param height Height of the board data array contained in the message.
52 * @param width Width of the board data array contained in the message.
53 * @param allocator Memory allocator (or kNULL for default).
54 * @return Operation status.
55 */
56 GoWebScanFx(kStatus) GoWebScanTracheidBoardMsg_Construct(GoWebScanTracheidBoardMsg* msg, kSize height, kSize width, kAlloc allocator);
57 
58 /**
59 * Resize a GoWebScanTracheidBoardMsg object.
60 *
61 * @public @memberof GoWebScanTracheidBoardMsg
62 * @param msg GoWebScanTracheidBoardMsg object.
63 * @param height New height.
64 * @param width New width.
65 * @return Operation status.
66 */
68 
69 /**
70 * Gets the height of a message.
71 *
72 * @public @memberof GoWebScanTracheidBoardMsg
73 * @param msg GoWebScanTracheidBoardMsg object.
74 * @return Message height.
75 */
77 
78 /**
79 * Gets the width of a message.
80 *
81 * @public @memberof GoWebScanTracheidBoardMsg
82 * @param msg GoWebScanTracheidBoardMsg object.
83 * @return Message width.
84 */
86 
87 /**
88 * Gets the attributes of a message.
89 *
90 * @public @memberof GoWebScanTracheidBoardMsg
91 * @param msg GoWebScanTracheidBoardMsg object.
92 * @return Message attributes.
93 */
95 
96 /**
97 * Gets the board angle data array.
98 *
99 * @public @memberof GoWebScanTracheidBoardMsg
100 * @param msg GoWebScanTracheidBoardMsg object.
101 * @return Data array containing board angle. Type k8u.
102 */
104 
105 /**
106 * Gets the spot angle at a specified row and column in the board array.
107 *
108 * @public @memberof GoWebScanTracheidBoardMsg
109 * @param msg GoWebScanTracheidBoardMsg object.
110 * @param rowIndex Row index (Y-axis).
111 * @param colIndex Column index (X-axis).
112 * @return Pointer to angle value.
113 */
114 GoWebScanFx(k8u*) GoWebScanTracheidBoardMsg_AngleAt(GoWebScanTracheidBoardMsg msg, kSize rowIndex, kSize colIndex);
115 
116 /**
117 * Gets the board scatter data array.
118 *
119 * @public @memberof GoWebScanTracheidBoardMsg
120 * @param msg GoWebScanTracheidBoardMsg object.
121 * @return Data array containing board scatter. Type k8u.
122 */
124 
125 /**
126 * Gets the spot scatter ratio at a specified row and column in the board array.
127 *
128 * @public @memberof GoWebScanTracheidBoardMsg
129 * @param msg GoWebScanTracheidBoardMsg object.
130 * @param rowIndex Row index (Y-axis).
131 * @param colIndex Column index (X-axis).
132 * @return Pointer to scatter value.
133 */
134 GoWebScanFx(k8u*) GoWebScanTracheidBoardMsg_ScatterAt(GoWebScanTracheidBoardMsg msg, kSize rowIndex, kSize colIndex);
135 
136 /**
137 * Gets the board area data array.
138 *
139 * @public @memberof GoWebScanTracheidBoardMsg
140 * @param msg GoWebScanTracheidBoardMsg object.
141 * @return Data array containing board area. Type k8u.
142 */
144 
145 /**
146 * Gets the spot area at a specified row and column in the board array.
147 *
148 * @public @memberof GoWebScanTracheidBoardMsg
149 * @param msg GoWebScanTracheidBoardMsg object.
150 * @param rowIndex Row index (Y-axis).
151 * @param colIndex Column index (X-axis).
152 * @return Pointer to area value.
153 */
154 GoWebScanFx(k8u*) GoWebScanTracheidBoardMsg_AreaAt(GoWebScanTracheidBoardMsg msg, kSize rowIndex, kSize colIndex);
155 
156 kEndHeader()
157 #include <GoWebScanSdk/GoWebScanTracheidBoardMsg.x.h>
158 
159 #endif
160 
k8u * GoWebScanTracheidBoardMsg_AngleAt(GoWebScanTracheidBoardMsg msg, kSize rowIndex, kSize colIndex)
Gets the spot angle at a specified row and column in the board array.
Represents the attributes of a tracheid board message.
Definition: GoWebScanTracheidBoardMsg.h:23
kArray2 GoWebScanTracheidBoardMsg_Scatter(GoWebScanTracheidBoardMsg msg)
Gets the board scatter data array.
k8u * GoWebScanTracheidBoardMsg_ScatterAt(GoWebScanTracheidBoardMsg msg, kSize rowIndex, kSize colIndex)
Gets the spot scatter ratio at a specified row and column in the board array.
k64s deviceId
Id of station device sending this message.
Definition: GoWebScanTracheidBoardMsg.h:25
Essential GoWebScan declarations.
k64s groupId
Group identifier: Top (0), or Bottom (1)
Definition: GoWebScanTracheidBoardMsg.h:26
k64s timestamp
Capture time.
Definition: GoWebScanTracheidBoardMsg.h:29
k64s xOrigin
Section x-location (from GoWebScanSettings Section/X0)
Definition: GoWebScanTracheidBoardMsg.h:32
GoWebScanTracheidBoardMsgAttr * GoWebScanTracheidBoardMsg_Attributes(GoWebScanTracheidBoardMsg msg)
Gets the attributes of a message.
k64s xResolution
Pixel width (mils)
Definition: GoWebScanTracheidBoardMsg.h:34
k64s encoder
Capture position (encoder ticks)
Definition: GoWebScanTracheidBoardMsg.h:30
k64s yOrigin
Section y-location (mils)
Definition: GoWebScanTracheidBoardMsg.h:31
kArray2 GoWebScanTracheidBoardMsg_Area(GoWebScanTracheidBoardMsg msg)
Gets the board area data array.
kArray2 GoWebScanTracheidBoardMsg_Angle(GoWebScanTracheidBoardMsg msg)
Gets the board angle data array.
kSize GoWebScanTracheidBoardMsg_Width(GoWebScanTracheidBoardMsg msg)
Gets the width of a message.
k64s yResolution
Pixel height (mils)
Definition: GoWebScanTracheidBoardMsg.h:33
kSize GoWebScanTracheidBoardMsg_Height(GoWebScanTracheidBoardMsg msg)
Gets the height of a message.
k64s sectionId
Section identifier (from GoWebScanSettings Section/Id)
Definition: GoWebScanTracheidBoardMsg.h:27
k8u * GoWebScanTracheidBoardMsg_AreaAt(GoWebScanTracheidBoardMsg msg, kSize rowIndex, kSize colIndex)
Gets the spot area at a specified row and column in the board array.
Represents a message containing spot angle, scatter ratio, and area measurements from a detected boar...
kStatus GoWebScanTracheidBoardMsg_Realloc(GoWebScanTracheidBoardMsg msg, kSize height, kSize width)
Resize a GoWebScanTracheidBoardMsg object.
k64s sequenceIndex
Board id; increases with each unique board.
Definition: GoWebScanTracheidBoardMsg.h:28
kStatus GoWebScanTracheidBoardMsg_Construct(GoWebScanTracheidBoardMsg *msg, kSize height, kSize width, kAlloc allocator)
Constructs a GoWebScanTracheidBoardMsg object.