GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanProfileTileMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanProfileTileMsg.h
3 * @brief Declares a GoWebScanProfileTileMsg 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_TILE_MSG_H
11 #define GO_SCANNER_PROFILE_TILE_MSG_H
12 
15 
16 kBeginHeader()
17 
18 /**
19 * @class GoWebScanProfileTileMsg
20 * @extends GoWebScanPipeMsg
21 * @ingroup GoWebScanSdk-Messages
22 * @brief Represents a message containing a tile of X and Y resampled profile Z data. This
23 * message can be used to represent data from a single node in the system, data
24 * from a plane in the system (after merging resampled data from all nodes in a plane),
25 * or data from a detected board.
26 *
27 */
29 
30 /**
31 * Constructs a GoWebScanProfileTileMsg object.
32 *
33 * @public @memberof GoWebScanProfileTileMsg
34 * @param msg Receives the constructed GoWebScanProfileTileMsg object.
35 * @param count Length of tile in Y-axis (pixels).
36 * @param width Length of tile in X-axis (pixels).
37 * @param pool Message pool of GoWebScanProfileTileMsg objects
38 * @param allocator Memory allocator (or kNULL for default).
39 * @return Operation status.
40 */
41 GoWebScanFx(kStatus) GoWebScanProfileTileMsg_Construct(GoWebScanProfileTileMsg* msg, kSize count, kSize width, GoWebScanPipeMsgPool pool, kAlloc allocator);
42 
43 /**
44 * Destroys a GoWebScanProfileTileMsg object.
45 *
46 * @public @memberof GoWebScanProfileTileMsg
47 * @param msg GoWebScanProfileTileMsg object.
48 * @return Operation status.
49 */
50 GoWebScanFx(kStatus) GoWebScanProfileTileMsg_Destroy(GoWebScanProfileTileMsg msg);
51 
52 /**
53 * Resizes a GoWebScanProfileTileMsg object.
54 *
55 * @public @memberof GoWebScanProfileTileMsg
56 * @param msg GoWebScanProfileTileMsg object.
57 * @param count Length of tile in Y-axis (pixels).
58 * @param width Length of tile in X-axis (pixels).
59 * @return Operation status.
60 */
61 GoWebScanFx(kStatus) GoWebScanProfileTileMsg_Resize(GoWebScanProfileTileMsg msg, kSize count, kSize width);
62 
63 /**
64 * Gets the size, in bytes, of the message data buffer.
65 *
66 * @public @memberof GoWebScanProfileTileMsg
67 * @param msg GoWebScanProfileTileMsg object.
68 * @return Message data buffer size (bytes).
69 */
70 GoWebScanFx(kSize) GoWebScanProfileTileMsg_Size(GoWebScanProfileTileMsg msg);
71 
72 /**
73 * Gets length of the tile in the Y-axis (pixels).
74 *
75 * @public @memberof GoWebScanProfileTileMsg
76 * @param msg GoWebScanProfileTileMsg object.
77 * @return Message count.
78 */
79 GoWebScanFx(kSize) GoWebScanProfileTileMsg_Count(GoWebScanProfileTileMsg msg);
80 
81 /**
82 * Gets length of the tile in the X-axis (pixels).
83 *
84 * @public @memberof GoWebScanProfileTileMsg
85 * @param msg GoWebScanProfileTileMsg object.
86 * @return Message width.
87 */
88 GoWebScanFx(kSize) GoWebScanProfileTileMsg_Width(GoWebScanProfileTileMsg msg);
89 
90 /**
91 * Gets the inputs corresponding to each row of the tile.
92 *
93 * @public @memberof GoWebScanProfileTileMsg
94 * @param msg GoWebScanProfileTileMsg object.
95 * @return Array of inputs. Type k64s.
96 */
97 GoWebScanFx(kArray1) GoWebScanProfileTileMsg_Inputs(GoWebScanProfileTileMsg msg);
98 
99 /**
100 * Gets the input at a specifed row.
101 *
102 * @public @memberof GoWebScanProfileTileMsg
103 * @param msg GoWebScanProfileTileMsg object.
104 * @param rowIndex Row index.
105 * @return Input at specified row.
106 */
107 GoWebScanFx(k64s*) GoWebScanProfileTileMsg_InputsAt(GoWebScanProfileTileMsg msg, kSize rowIndex);
108 
109 /**
110 * Gets the tile data array.
111 *
112 * @public @memberof GoWebScanProfileTileMsg
113 * @param msg GoWebScanProfileTileMsg object.
114 * @return Message data array. Type k16s.
115 */
116 GoWebScanFx(kArray2) GoWebScanProfileTileMsg_Data(GoWebScanProfileTileMsg msg);
117 
118 /**
119 * Gets a pointer to the start of a tile row.
120 *
121 * @public @memberof GoWebScanProfileTileMsg
122 * @param msg GoWebScanProfileTileMsg object.
123 * @param rowIndex Row index.
124 * @return Pointer to start of row.
125 */
126 GoWebScanFx(k16s*) GoWebScanProfileTileMsg_DataAt(GoWebScanProfileTileMsg msg, kSize rowIndex);
127 
128 kEndHeader()
129 #include <GoWebScanSdk/GoWebScanProfileTileMsg.x.h>
130 
131 #endif
132 
kArray1 GoWebScanProfileTileMsg_Inputs(GoWebScanProfileTileMsg msg)
Gets the inputs corresponding to each row of the tile.
Declares the GoWebScanPipeMsg class.
Essential GoWebScan declarations.
k64s * GoWebScanProfileTileMsg_InputsAt(GoWebScanProfileTileMsg msg, kSize rowIndex)
Gets the input at a specifed row.
k16s * GoWebScanProfileTileMsg_DataAt(GoWebScanProfileTileMsg msg, kSize rowIndex)
Gets a pointer to the start of a tile row.
kStatus GoWebScanProfileTileMsg_Resize(GoWebScanProfileTileMsg msg, kSize count, kSize width)
Resizes a GoWebScanProfileTileMsg object.
kStatus GoWebScanProfileTileMsg_Construct(GoWebScanProfileTileMsg *msg, kSize count, kSize width, GoWebScanPipeMsgPool pool, kAlloc allocator)
Constructs a GoWebScanProfileTileMsg object.
Represents a message containing a tile of X and Y resampled profile Z data. This message can be used ...
kSize GoWebScanProfileTileMsg_Width(GoWebScanProfileTileMsg msg)
Gets length of the tile in the X-axis (pixels).
kSize GoWebScanProfileTileMsg_Count(GoWebScanProfileTileMsg msg)
Gets length of the tile in the Y-axis (pixels).
Represents a pool of GoWebScanPipeMsg objects. The pool allocates GoWebScanPipeMsg objects with a def...
Base class for a msg that can be processed with a GoWebScanPipeTask and submitted to the GoWebScanPip...
kSize GoWebScanProfileTileMsg_Size(GoWebScanProfileTileMsg msg)
Gets the size, in bytes, of the message data buffer.
kArray2 GoWebScanProfileTileMsg_Data(GoWebScanProfileTileMsg msg)
Gets the tile data array.
kStatus GoWebScanProfileTileMsg_Destroy(GoWebScanProfileTileMsg msg)
Destroys a GoWebScanProfileTileMsg object.