GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanVisionWebMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanVisionWebMsg.h
3 * @brief Declares a GoWebScanVisionWebMsg 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_VISION_WEB_MSG_H
11 #define GO_SCANNER_VISION_WEB_MSG_H
12 
14 
15 kBeginHeader()
16 
17 /**
18 * @struct GoWebScanVisionWebMsgAttr
19 * @extends kValue
20 * @ingroup GoWebScanSdk-Messages
21 * @brief Represents the attributes of a vision 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 GoWebScanVisionWebMsg
39 * @extends kObject
40 * @ingroup GoWebScanSdk-Messages
41 * @brief Represents a message containing a tile of resampled and merged demosaiced vision
42 * data for a given section.
43 */
45 
46 /**
47 * Constructs a GoWebScanVisionWebMsg msg.
48 *
49 * @public @memberof GoWebScanVisionWebMsg
50 * @param msg Receives the constructed GoWebScanVisionWebMsg msg.
51 * @param pixelType Pixel type of the tile data array contained in the message.
52 * @param height Height of the tile data array contained in the message.
53 * @param width Width of the tile data array contained in the message.
54 * @param allocator Memory allocator (or kNULL for default).
55 * @return Operation status.
56 */
57 GoWebScanFx(kStatus) GoWebScanVisionWebMsg_Construct(GoWebScanVisionWebMsg* msg, kType pixelType, kSize height, kSize width, kAlloc allocator);
58 
59 /**
60 * Resize a GoWebScanVisionWebMsg msg.
61 *
62 * @public @memberof GoWebScanVisionWebMsg
63 * @param msg GoWebScanVisionWebMsg msg.
64 * @param height New height.
65 * @param width New width.
66 * @return Operation status.
67 */
69 
70 /**
71 * Gets the height of a message.
72 *
73 * @public @memberof GoWebScanVisionWebMsg
74 * @param msg GoWebScanVisionWebMsg msg.
75 * @return Message height.
76 */
78 
79 /**
80 * Gets the width of a message.
81 *
82 * @public @memberof GoWebScanVisionWebMsg
83 * @param msg GoWebScanVisionWebMsg msg.
84 * @return Message width.
85 */
87 
88 /**
89 * Gets the pixel type of a message.
90 *
91 * @public @memberof GoWebScanVisionWebMsg
92 * @param msg GoWebScanVisionWebMsg msg.
93 * @return Message pixel type.
94 */
96 
97 /**
98 * Gets the attributes of a message.
99 *
100 * @public @memberof GoWebScanVisionWebMsg
101 * @param msg GoWebScanVisionWebMsg msg.
102 * @return Message attributes.
103 */
105 
106 /**
107 * Gets the inputs corresponding to each row of the tile.
108 *
109 * @public @memberof GoWebScanVisionWebMsg
110 * @param msg GoWebScanVisionWebMsg msg.
111 * @return Array of inputs. Type k64s.
112 */
114 
115 /**
116 * Gets the input at a specifed row.
117 *
118 * @public @memberof GoWebScanVisionWebMsg
119 * @param msg GoWebScanVisionWebMsg msg.
120 * @param index Row index.
121 * @return Input at specified row.
122 */
124 
125 /**
126 * Gets the tile data array.
127 *
128 * @public @memberof GoWebScanVisionWebMsg
129 * @param msg GoWebScanVisionWebMsg msg.
130 * @return Message data array. Type pixelType used to construct message.
131 */
133 
134 /**
135 * Gets a pointer to the data value at a specified row and column index.
136 *
137 * @public @memberof GoWebScanVisionWebMsg
138 * @param msg GoWebScanVisionWebMsg msg.
139 * @param rowIndex Row index (Y-axis).
140 * @param colIndex Column index (X-axis).
141 * @return Pointer to value. Can be cast into pixelType used to construct message.
142 */
143 GoWebScanFx(kPointer) GoWebScanVisionWebMsg_DataAt(GoWebScanVisionWebMsg msg, kSize rowIndex, kSize colIndex);
144 
145 kEndHeader()
146 #include <GoWebScanSdk/GoWebScanVisionWebMsg.x.h>
147 
148 #endif
149 
k64s encoder
Capture position (encoder ticks)
Definition: GoWebScanVisionWebMsg.h:30
k64s xOrigin
Section x-location (from GoWebScanSettings Section/X0)
Definition: GoWebScanVisionWebMsg.h:32
kType GoWebScanVisionWebMsg_PixelType(GoWebScanVisionWebMsg msg)
Gets the pixel type of a message.
k64s yOrigin
Section y-location (mils)
Definition: GoWebScanVisionWebMsg.h:31
kSize GoWebScanVisionWebMsg_Height(GoWebScanVisionWebMsg msg)
Gets the height of a message.
kStatus GoWebScanVisionWebMsg_Realloc(GoWebScanVisionWebMsg msg, kSize height, kSize width)
Resize a GoWebScanVisionWebMsg msg.
Essential GoWebScan declarations.
k64s sectionId
Section identifier (from GoWebScanSettings Section/Id)
Definition: GoWebScanVisionWebMsg.h:27
k64s yResolution
Pixel height (mils)
Definition: GoWebScanVisionWebMsg.h:33
GoWebScanVisionWebMsgAttr * GoWebScanVisionWebMsg_Attributes(GoWebScanVisionWebMsg msg)
Gets the attributes of a message.
kPointer GoWebScanVisionWebMsg_DataAt(GoWebScanVisionWebMsg msg, kSize rowIndex, kSize colIndex)
Gets a pointer to the data value at a specified row and column index.
k64s xResolution
Pixel width (mils)
Definition: GoWebScanVisionWebMsg.h:34
k64s sequenceIndex
Tile id; increases with each unique tile.
Definition: GoWebScanVisionWebMsg.h:28
kStatus GoWebScanVisionWebMsg_Construct(GoWebScanVisionWebMsg *msg, kType pixelType, kSize height, kSize width, kAlloc allocator)
Constructs a GoWebScanVisionWebMsg msg.
kSize GoWebScanVisionWebMsg_Width(GoWebScanVisionWebMsg msg)
Gets the width of a message.
kArray1 GoWebScanVisionWebMsg_Inputs(GoWebScanVisionWebMsg msg)
Gets the inputs corresponding to each row of the tile.
k64s deviceId
Id of station device sending this message.
Definition: GoWebScanVisionWebMsg.h:25
k64s groupId
Group identifier: Top (0), or Bottom (1)
Definition: GoWebScanVisionWebMsg.h:26
Represents a message containing a tile of resampled and merged demosaiced vision data for a given sec...
k64s timestamp
Capture time.
Definition: GoWebScanVisionWebMsg.h:29
kArray2 GoWebScanVisionWebMsg_Data(GoWebScanVisionWebMsg msg)
Gets the tile data array.
Represents the attributes of a vision web message.
Definition: GoWebScanVisionWebMsg.h:23
k64s * GoWebScanVisionWebMsg_InputsAt(GoWebScanVisionWebMsg msg, kSize index)
Gets the input at a specifed row.