GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanProfileBoardMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanProfileBoardMsg.h
3 * @brief Declares a GoWebScanProfileBoardMsg 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_BOARD_MSG_H
11 #define GO_SCANNER_PROFILE_BOARD_MSG_H
12 
14 
15 kBeginHeader()
16 
17 /**
18 * @struct GoWebScanProfileBoardMsgAttr
19 * @extends kValue
20 * @ingroup GoWebScanSdk-Messages
21 * @brief Represents the attributes of a profile 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 GoWebScanProfileBoardMsg
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 GoWebScanProfileBoardMsg object.
48 *
49 * @public @memberof GoWebScanProfileBoardMsg
50 * @param msg Receives the constructed GoWebScanProfileBoardMsg 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) GoWebScanProfileBoardMsg_Construct(GoWebScanProfileBoardMsg* msg, kSize height, kSize width, kAlloc allocator);
57 
58 /**
59 * Resize a GoWebScanProfileBoardMsg object.
60 *
61 * @public @memberof GoWebScanProfileBoardMsg
62 * @param msg GoWebScanProfileBoardMsg 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 GoWebScanProfileBoardMsg
73 * @param msg GoWebScanProfileBoardMsg object.
74 * @return Message height.
75 */
77 
78 /**
79 * Gets the width of a message.
80 *
81 * @public @memberof GoWebScanProfileBoardMsg
82 * @param msg GoWebScanProfileBoardMsg object.
83 * @return Message width.
84 */
86 
87 /**
88 * Gets the attributes of a message.
89 *
90 * @public @memberof GoWebScanProfileBoardMsg
91 * @param msg GoWebScanProfileBoardMsg object.
92 * @return Message attributes.
93 */
95 
96 /**
97 * Gets the board data array.
98 *
99 * @public @memberof GoWebScanProfileBoardMsg
100 * @param msg GoWebScanProfileBoardMsg object.
101 * @return Data array containing board. Type k16s.
102 */
104 
105 /**
106 * Gets the Z value (mils) at a specified row and column in the board array.
107 *
108 * @public @memberof GoWebScanProfileBoardMsg
109 * @param msg GoWebScanProfileBoardMsg object.
110 * @param rowIndex Row index (Y-axis).
111 * @param colIndex Column index (X-axis).
112 * @return Pointer to Z value.
113 */
114 GoWebScanFx(k16s*) GoWebScanProfileBoardMsg_DataAt(GoWebScanProfileBoardMsg msg, kSize rowIndex, kSize colIndex);
115 
116 kEndHeader()
117 #include <GoWebScanSdk/GoWebScanProfileBoardMsg.x.h>
118 
119 #endif
120 
k64s sequenceIndex
Board id; increases with each unique board.
Definition: GoWebScanProfileBoardMsg.h:28
k64s timestamp
Capture time.
Definition: GoWebScanProfileBoardMsg.h:29
Represents the attributes of a profile board message.
Definition: GoWebScanProfileBoardMsg.h:23
k64s sectionId
Section identifier (from GoWebScanSettings Section/Id)
Definition: GoWebScanProfileBoardMsg.h:27
kStatus GoWebScanProfileBoardMsg_Realloc(GoWebScanProfileBoardMsg msg, kSize height, kSize width)
Resize a GoWebScanProfileBoardMsg object.
k64s xOrigin
Section x-location (from GoWebScanSettings Section/X0)
Definition: GoWebScanProfileBoardMsg.h:32
k64s yOrigin
Section y-location (mils)
Definition: GoWebScanProfileBoardMsg.h:31
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: GoWebScanProfileBoardMsg.h:25
Essential GoWebScan declarations.
GoWebScanProfileBoardMsgAttr * GoWebScanProfileBoardMsg_Attributes(GoWebScanProfileBoardMsg msg)
Gets the attributes of a message.
kSize GoWebScanProfileBoardMsg_Height(GoWebScanProfileBoardMsg msg)
Gets the height of a message.
kArray2 GoWebScanProfileBoardMsg_Data(GoWebScanProfileBoardMsg msg)
Gets the board data array.
k64s xResolution
Pixel width (mils)
Definition: GoWebScanProfileBoardMsg.h:34
k16s * GoWebScanProfileBoardMsg_DataAt(GoWebScanProfileBoardMsg msg, kSize rowIndex, kSize colIndex)
Gets the Z value (mils) at a specified row and column in the board array.
k64s yResolution
Pixel height (mils)
Definition: GoWebScanProfileBoardMsg.h:33
k64s groupId
Group identifier: Top (0), or Bottom (1)
Definition: GoWebScanProfileBoardMsg.h:26
kSize GoWebScanProfileBoardMsg_Width(GoWebScanProfileBoardMsg msg)
Gets the width of a message.
k64s encoder
Capture position (encoder ticks)
Definition: GoWebScanProfileBoardMsg.h:30
kStatus GoWebScanProfileBoardMsg_Construct(GoWebScanProfileBoardMsg *msg, kSize height, kSize width, kAlloc allocator)
Constructs a GoWebScanProfileBoardMsg object.