GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanVisionBoardMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanVisionBoardMsg.h
3 * @brief Declares a GoWebScanVisionBoardMsg 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_BOARD_MSG_H
11 #define GO_SCANNER_VISION_BOARD_MSG_H
12 
14 
15 kBeginHeader()
16 
17 /**
18 * @struct GoWebScanVisionBoardMsgAttr
19 * @extends kValue
20 * @ingroup GoWebScanSdk-Messages
21 * @brief Represents the attributes of a vision 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 GoWebScanVisionBoardMsg
39 * @extends kObject
40 * @ingroup GoWebScanSdk-Messages
41 * @brief Represents a message containing resampled and merged geometric data of a detected board
42 * for a given section.
43 */
45 
46 /**
47 * Constructs a GoWebScanVisionBoardMsg board.
48 *
49 * @public @memberof GoWebScanVisionBoardMsg
50 * @param msg Receives the constructed GoWebScanVisionBoardMsg object.
51 * @param pixelType Pixel type of the board data array contained in the message.
52 * @param height Height of the board data array contained in the message.
53 * @param width Width of the board data array contained in the message.
54 * @param allocator Memory allocator (or kNULL for default).
55 * @return Operation status.
56 */
57 GoWebScanFx(kStatus) GoWebScanVisionBoardMsg_Construct(GoWebScanVisionBoardMsg* msg, kType pixelType, kSize height, kSize width, kAlloc allocator);
58 
59 /**
60 * Resize a GoWebScanVisionBoardMsg object.
61 *
62 * @public @memberof GoWebScanVisionBoardMsg
63 * @param msg GoWebScanVisionBoardMsg object.
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 GoWebScanVisionBoardMsg
74 * @param msg GoWebScanVisionBoardMsg object.
75 * @return Message height.
76 */
78 
79 /**
80 * Gets the width of a message.
81 *
82 * @public @memberof GoWebScanVisionBoardMsg
83 * @param msg GoWebScanVisionBoardMsg object.
84 * @return Message width.
85 */
87 
88 /**
89 * Gets the pixel type of a message.
90 *
91 * @public @memberof GoWebScanVisionBoardMsg
92 * @param msg GoWebScanVisionBoardMsg object.
93 * @return Message pixel type.
94 */
96 
97 /**
98 * Gets the attributes of a message.
99 *
100 * @public @memberof GoWebScanVisionBoardMsg
101 * @param msg GoWebScanVisionBoardMsg object.
102 * @return Message attributes.
103 */
105 
106 /**
107 * Gets the board data array.
108 *
109 * @public @memberof GoWebScanVisionBoardMsg
110 * @param msg GoWebScanVisionBoardMsg object.
111 * @return Data array containing board. Type pixelType used to construct board.
112 */
114 
115 /**
116 * Gets the pixel value at a specified row and column in the board array.
117 *
118 * @public @memberof GoWebScanVisionBoardMsg
119 * @param msg GoWebScanVisionBoardMsg object.
120 * @param rowIndex Row index (Y-axis).
121 * @param colIndex Column index (X-axis).
122 * @return Pointer to pixel value (of same type as pixelType parameter in object construction).
123 */
124 GoWebScanFx(kPointer) GoWebScanVisionBoardMsg_DataAt(GoWebScanVisionBoardMsg msg, kSize rowIndex, kSize colIndex);
125 
126 kEndHeader()
127 #include <GoWebScanSdk/GoWebScanVisionBoardMsg.x.h>
128 
129 #endif
130 
k64s xOrigin
Section x-location (from GoWebScanSettings Section/X0)
Definition: GoWebScanVisionBoardMsg.h:32
k64s groupId
Group identifier: Top (0), or Bottom (1)
Definition: GoWebScanVisionBoardMsg.h:26
Represents a message containing resampled and merged geometric data of a detected board for a given s...
k64s deviceId
Id of station device sending this message.
Definition: GoWebScanVisionBoardMsg.h:25
k64s sectionId
Section identifier (from GoWebScanSettings Section/Id)
Definition: GoWebScanVisionBoardMsg.h:27
kStatus GoWebScanVisionBoardMsg_Construct(GoWebScanVisionBoardMsg *msg, kType pixelType, kSize height, kSize width, kAlloc allocator)
Constructs a GoWebScanVisionBoardMsg board.
Essential GoWebScan declarations.
k64s timestamp
Capture time.
Definition: GoWebScanVisionBoardMsg.h:29
k64s yResolution
Pixel height (mils)
Definition: GoWebScanVisionBoardMsg.h:33
kSize GoWebScanVisionBoardMsg_Width(GoWebScanVisionBoardMsg msg)
Gets the width of a message.
kType GoWebScanVisionBoardMsg_PixelType(GoWebScanVisionBoardMsg msg)
Gets the pixel type of a message.
k64s encoder
Capture position (encoder ticks)
Definition: GoWebScanVisionBoardMsg.h:30
kSize GoWebScanVisionBoardMsg_Height(GoWebScanVisionBoardMsg msg)
Gets the height of a message.
k64s sequenceIndex
Board id; increases with each unique board.
Definition: GoWebScanVisionBoardMsg.h:28
k64s xResolution
Pixel width (mils)
Definition: GoWebScanVisionBoardMsg.h:34
kStatus GoWebScanVisionBoardMsg_Realloc(GoWebScanVisionBoardMsg msg, kSize height, kSize width)
Resize a GoWebScanVisionBoardMsg object.
kPointer GoWebScanVisionBoardMsg_DataAt(GoWebScanVisionBoardMsg msg, kSize rowIndex, kSize colIndex)
Gets the pixel value at a specified row and column in the board array.
kArray2 GoWebScanVisionBoardMsg_Data(GoWebScanVisionBoardMsg msg)
Gets the board data array.
Represents the attributes of a vision board message.
Definition: GoWebScanVisionBoardMsg.h:23
k64s yOrigin
Section y-location (mils)
Definition: GoWebScanVisionBoardMsg.h:31
GoWebScanVisionBoardMsgAttr * GoWebScanVisionBoardMsg_Attributes(GoWebScanVisionBoardMsg msg)
Gets the attributes of a message.