GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanProfileWebMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanProfileWebMsg.h
3 * @brief Declares a GoWebScanProfileWebMsg 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_PROFILE_WEB_MSG_H
11 #define GO_SCANNER_PROFILE_WEB_MSG_H
12 
14 
15 kBeginHeader()
16 
17 /**
18 * @struct GoWebScanProfileWebMsgAttr
19 * @extends kValue
20 * @ingroup GoWebScanSdk-Messages
21 * @brief Represents the attributes of a profile 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 GoWebScanProfileWebMsg
39 * @extends kObject
40 * @ingroup GoWebScanSdk-Messages
41 * @brief Represents a message containing a tile of resampled and merged geometric data for a
42 * given section.
43 */
45 
46 /**
47 * Constructs a GoWebScanProfileWebMsg msg.
48 *
49 * @public @memberof GoWebScanProfileWebMsg
50 * @param msg Receives the constructed GoWebScanProfileWebMsg 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) GoWebScanProfileWebMsg_Construct(GoWebScanProfileWebMsg* msg, kSize height, kSize width, kAlloc allocator);
57 
58 /**
59 * Resize a GoWebScanProfileWebMsg msg.
60 *
61 * @public @memberof GoWebScanProfileWebMsg
62 * @param msg GoWebScanProfileWebMsg 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 GoWebScanProfileWebMsg
73 * @param msg GoWebScanProfileWebMsg msg.
74 * @return Message height.
75 */
77 
78 /**
79 * Gets the width of a message.
80 *
81 * @public @memberof GoWebScanProfileWebMsg
82 * @param msg GoWebScanProfileWebMsg msg.
83 * @return Message width.
84 */
86 
87 /**
88 * Gets the attributes of a message.
89 *
90 * @public @memberof GoWebScanProfileWebMsg
91 * @param msg GoWebScanProfileWebMsg msg.
92 * @return Message attributes.
93 */
95 
96 /**
97 * Gets the inputs corresponding to each row of the tile.
98 *
99 * @public @memberof GoWebScanProfileWebMsg
100 * @param msg GoWebScanProfileWebMsg msg.
101 * @return Array of inputs. Type k64s.
102 */
104 
105 /**
106 * Gets the input at a specifed row.
107 *
108 * @public @memberof GoWebScanProfileWebMsg
109 * @param msg GoWebScanProfileWebMsg msg.
110 * @param index Row index.
111 * @return Input at specified row.
112 */
114 
115 /**
116 * Gets the tile data array.
117 *
118 * @public @memberof GoWebScanProfileWebMsg
119 * @param msg GoWebScanProfileWebMsg msg.
120 * @return Message data array. Type k16s.
121 */
123 
124 /**
125 * Gets a pointer to the data value at a specified row and column index.
126 *
127 * @public @memberof GoWebScanProfileWebMsg
128 * @param msg GoWebScanProfileWebMsg msg.
129 * @param rowIndex Row index (Y-axis).
130 * @param colIndex Column index (X-axis).
131 * @return Pointer to value.
132 */
133 GoWebScanFx(k16s*) GoWebScanProfileWebMsg_DataAt(GoWebScanProfileWebMsg msg, kSize rowIndex, kSize colIndex);
134 
135 kEndHeader()
136 #include <GoWebScanSdk/GoWebScanProfileWebMsg.x.h>
137 
138 #endif
139 
kSize GoWebScanProfileWebMsg_Width(GoWebScanProfileWebMsg msg)
Gets the width of a message.
k64s groupId
Group identifier: Top (0), or Bottom (1)
Definition: GoWebScanProfileWebMsg.h:26
k64s sequenceIndex
Tile id; increases with each unique tile.
Definition: GoWebScanProfileWebMsg.h:28
kArray2 GoWebScanProfileWebMsg_Data(GoWebScanProfileWebMsg msg)
Gets the tile data array.
k64s timestamp
Capture time.
Definition: GoWebScanProfileWebMsg.h:29
k64s xResolution
Pixel width (mils)
Definition: GoWebScanProfileWebMsg.h:34
k64s sectionId
Section identifier (from GoWebScanSettings Section/Id)
Definition: GoWebScanProfileWebMsg.h:27
Represents the attributes of a profile web message.
Definition: GoWebScanProfileWebMsg.h:23
Essential GoWebScan declarations.
k64s yResolution
Pixel height (mils)
Definition: GoWebScanProfileWebMsg.h:33
kStatus GoWebScanProfileWebMsg_Realloc(GoWebScanProfileWebMsg msg, kSize height, kSize width)
Resize a GoWebScanProfileWebMsg msg.
k16s * GoWebScanProfileWebMsg_DataAt(GoWebScanProfileWebMsg msg, kSize rowIndex, kSize colIndex)
Gets a pointer to the data value at a specified row and column index.
k64s deviceId
Id of station device sending this message.
Definition: GoWebScanProfileWebMsg.h:25
Represents a message containing a tile of resampled and merged geometric data for a given section...
k64s * GoWebScanProfileWebMsg_InputsAt(GoWebScanProfileWebMsg msg, kSize index)
Gets the input at a specifed row.
GoWebScanProfileWebMsgAttr * GoWebScanProfileWebMsg_Attributes(GoWebScanProfileWebMsg msg)
Gets the attributes of a message.
kArray1 GoWebScanProfileWebMsg_Inputs(GoWebScanProfileWebMsg msg)
Gets the inputs corresponding to each row of the tile.
kStatus GoWebScanProfileWebMsg_Construct(GoWebScanProfileWebMsg *msg, kSize height, kSize width, kAlloc allocator)
Constructs a GoWebScanProfileWebMsg msg.
k64s yOrigin
Section y-location (mils)
Definition: GoWebScanProfileWebMsg.h:31
k64s xOrigin
Section x-location (from GoWebScanSettings Section/X0)
Definition: GoWebScanProfileWebMsg.h:32
kSize GoWebScanProfileWebMsg_Height(GoWebScanProfileWebMsg msg)
Gets the height of a message.
k64s encoder
Capture position (encoder ticks)
Definition: GoWebScanProfileWebMsg.h:30