GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanTracheidWebMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanTracheidWebMsg.h
3 * @brief Declares a GoWebScanTracheidWebMsg 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_WEB_MSG_H
11 #define GO_SCANNER_TRACHEID_WEB_MSG_H
12 
14 
15 kBeginHeader()
16 
17 /**
18 * @struct GoWebScanTracheidWebMsgAttr
19 * @extends kValue
20 * @ingroup GoWebScanSdk-Messages
21 * @brief Represents the attributes of a tracheid web 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; ///< Tile id; increases with each unique tile
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 GoWebScanTracheidWebMsg
39 * @extends kObject
40 * @ingroup GoWebScanSdk-Messages
41 * @brief Represents a message containing a tile of resampled and merged spot angle,
42 * scatter, and area data for a given section.
43 */
45 
46 /**
47 * Constructs a GoWebScanTracheidWebMsg msg.
48 *
49 * @public @memberof GoWebScanTracheidWebMsg
50 * @param msg Receives the constructed GoWebScanTracheidWebMsg msg.
51 * @param height Height of the tile data array contained in the message.
52 * @param width Width of the tile data array contained in the message.
53 * @param allocator Memory allocator (or kNULL for default).
54 * @return Operation status.
55 */
56 GoWebScanFx(kStatus) GoWebScanTracheidWebMsg_Construct(GoWebScanTracheidWebMsg* msg, kSize height, kSize width, kAlloc allocator);
57 
58 /**
59 * Resize a GoWebScanTracheidWebMsg msg.
60 *
61 * @public @memberof GoWebScanTracheidWebMsg
62 * @param msg GoWebScanTracheidWebMsg msg.
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 GoWebScanTracheidWebMsg
73 * @param msg GoWebScanTracheidWebMsg msg.
74 * @return Message height.
75 */
77 
78 /**
79 * Gets the width of a message.
80 *
81 * @public @memberof GoWebScanTracheidWebMsg
82 * @param msg GoWebScanTracheidWebMsg msg.
83 * @return Message width.
84 */
86 
87 /**
88 * Gets the attributes of a message.
89 *
90 * @public @memberof GoWebScanTracheidWebMsg
91 * @param msg GoWebScanTracheidWebMsg msg.
92 * @return Message attributes.
93 */
95 
96 /**
97 * Gets the inputs corresponding to each row of the tile.
98 *
99 * @public @memberof GoWebScanTracheidWebMsg
100 * @param msg GoWebScanTracheidWebMsg msg.
101 * @return Array of inputs. Type k64s.
102 */
104 
105 /**
106 * Gets the input at a specifed row.
107 *
108 * @public @memberof GoWebScanTracheidWebMsg
109 * @param msg GoWebScanTracheidWebMsg msg.
110 * @param index Row index.
111 * @return Input at specified row.
112 */
114 
115 /**
116 * Gets the tile angle data array.
117 *
118 * @public @memberof GoWebScanTracheidWebMsg
119 * @param msg GoWebScanTracheidWebMsg msg.
120 * @return Message angle data array. Type k8u.
121 */
123 
124 /**
125 * Gets a pointer to the angle value at a specified row and column index.
126 *
127 * @public @memberof GoWebScanTracheidWebMsg
128 * @param msg GoWebScanTracheidWebMsg msg.
129 * @param rowIndex Row index (Y-axis).
130 * @param colIndex Column index (X-axis).
131 * @return Pointer to angle value.
132 */
133 GoWebScanFx(k8u*) GoWebScanTracheidWebMsg_AngleAt(GoWebScanTracheidWebMsg msg, kSize rowIndex, kSize colIndex);
134 
135 /**
136 * Gets the tile scatter data array.
137 *
138 * @public @memberof GoWebScanTracheidWebMsg
139 * @param msg GoWebScanTracheidWebMsg msg.
140 * @return Message scatter data array. Type k8u.
141 */
143 
144 /**
145 * Gets a pointer to the scatter value at a specified row and column index.
146 *
147 * @public @memberof GoWebScanTracheidWebMsg
148 * @param msg GoWebScanTracheidWebMsg msg.
149 * @param rowIndex Row index (Y-axis).
150 * @param colIndex Column index (X-axis).
151 * @return Pointer to scatter value.
152 */
153 GoWebScanFx(k8u*) GoWebScanTracheidWebMsg_ScatterAt(GoWebScanTracheidWebMsg msg, kSize rowIndex, kSize colIndex);
154 
155 /**
156 * Gets the tile area data array.
157 *
158 * @public @memberof GoWebScanTracheidWebMsg
159 * @param msg GoWebScanTracheidWebMsg msg.
160 * @return Message area data array. Type k8u.
161 */
163 
164 /**
165 * Gets a pointer to the area value at a specified row and column index.
166 *
167 * @public @memberof GoWebScanTracheidWebMsg
168 * @param msg GoWebScanTracheidWebMsg msg.
169 * @param rowIndex Row index (Y-axis).
170 * @param colIndex Column index (X-axis).
171 * @return Pointer to area value.
172 */
173 GoWebScanFx(k8u*) GoWebScanTracheidWebMsg_AreaAt(GoWebScanTracheidWebMsg msg, kSize rowIndex, kSize colIndex);
174 
175 kEndHeader()
176 #include <GoWebScanSdk/GoWebScanTracheidWebMsg.x.h>
177 
178 #endif
179 
kStatus GoWebScanTracheidWebMsg_Construct(GoWebScanTracheidWebMsg *msg, kSize height, kSize width, kAlloc allocator)
Constructs a GoWebScanTracheidWebMsg msg.
Represents the attributes of a tracheid web message.
Definition: GoWebScanTracheidWebMsg.h:23
kStatus GoWebScanTracheidWebMsg_Realloc(GoWebScanTracheidWebMsg msg, kSize height, kSize width)
Resize a GoWebScanTracheidWebMsg msg.
kArray2 GoWebScanTracheidWebMsg_Scatter(GoWebScanTracheidWebMsg msg)
Gets the tile scatter data array.
kArray2 GoWebScanTracheidWebMsg_Angle(GoWebScanTracheidWebMsg msg)
Gets the tile angle data array.
k8u * GoWebScanTracheidWebMsg_AreaAt(GoWebScanTracheidWebMsg msg, kSize rowIndex, kSize colIndex)
Gets a pointer to the area value at a specified row and column index.
kSize GoWebScanTracheidWebMsg_Width(GoWebScanTracheidWebMsg msg)
Gets the width of a message.
Essential GoWebScan declarations.
k64s deviceId
Id of station device sending this message.
Definition: GoWebScanTracheidWebMsg.h:25
k64s encoder
Capture position (encoder ticks)
Definition: GoWebScanTracheidWebMsg.h:30
k8u * GoWebScanTracheidWebMsg_AngleAt(GoWebScanTracheidWebMsg msg, kSize rowIndex, kSize colIndex)
Gets a pointer to the angle value at a specified row and column index.
k8u * GoWebScanTracheidWebMsg_ScatterAt(GoWebScanTracheidWebMsg msg, kSize rowIndex, kSize colIndex)
Gets a pointer to the scatter value at a specified row and column index.
k64s sectionId
Section identifier (from GoWebScanSettings Section/Id)
Definition: GoWebScanTracheidWebMsg.h:27
k64s timestamp
Capture time.
Definition: GoWebScanTracheidWebMsg.h:29
Represents a message containing a tile of resampled and merged spot angle, scatter, and area data for a given section.
GoWebScanTracheidWebMsgAttr * GoWebScanTracheidWebMsg_Attributes(GoWebScanTracheidWebMsg msg)
Gets the attributes of a message.
kArray2 GoWebScanTracheidWebMsg_Area(GoWebScanTracheidWebMsg msg)
Gets the tile area data array.
k64s xResolution
Pixel width (mils)
Definition: GoWebScanTracheidWebMsg.h:34
k64s * GoWebScanTracheidWebMsg_InputsAt(GoWebScanTracheidWebMsg msg, kSize index)
Gets the input at a specifed row.
k64s sequenceIndex
Tile id; increases with each unique tile.
Definition: GoWebScanTracheidWebMsg.h:28
k64s yOrigin
Section y-location (mils)
Definition: GoWebScanTracheidWebMsg.h:31
kArray1 GoWebScanTracheidWebMsg_Inputs(GoWebScanTracheidWebMsg msg)
Gets the inputs corresponding to each row of the tile.
k64s groupId
Group identifier: Top (0), or Bottom (1)
Definition: GoWebScanTracheidWebMsg.h:26
kSize GoWebScanTracheidWebMsg_Height(GoWebScanTracheidWebMsg msg)
Gets the height of a message.
k64s yResolution
Pixel height (mils)
Definition: GoWebScanTracheidWebMsg.h:33
k64s xOrigin
Section x-location (from GoWebScanSettings Section/X0)
Definition: GoWebScanTracheidWebMsg.h:32