GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanTracheidInputMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanTracheidInputMsg.h
3 * @brief Declares a GoWebScanTracheidInputMsg 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_TRACHEID_INPUT_MSG_H
11 #define GO_SCANNER_TRACHEID_INPUT_MSG_H
12 
16 #include <GoSdk/GoSdk.h>
17 
18 kBeginHeader()
19 
20 /**
21 * @class GoWebScanTracheidInputMsg
22 * @extends GoWebScanPipeMsg
23 * @ingroup GoWebScanSdk-Messages
24 * @brief Represents a message containing a raw tracheid message from a sensor.
25 */
27 
28 /**
29 * Constructs a GoWebScanTracheidInputMsg object.
30 *
31 * @public @memberof GoWebScanTracheidInputMsg
32 * @param msg Receives the constructed GoWebScanTracheidInputMsg object.
33 * @param pool Message pool of GoWebScanTracheidInputMsg objects
34 * @param allocator Memory allocator (or kNULL for default).
35 * @return Operation status.
36 */
37 GoWebScanFx(kStatus) GoWebScanTracheidInputMsg_Construct(GoWebScanTracheidInputMsg* msg, GoWebScanPipeMsgPool pool, kAlloc allocator);
38 
39 /**
40 * Destroys a GoWebScanTracheidInputMsg object.
41 *
42 * @public @memberof GoWebScanTracheidInputMsg
43 * @param msg GoWebScanTracheidInputMsg object.
44 * @return Operation status.
45 */
46 GoWebScanFx(kStatus) GoWebScanTracheidInputMsg_Destroy(GoWebScanTracheidInputMsg msg);
47 
48 /**
49  * Imports a GoTracheidMsg into a GoWebScanTracheidInputMsg object. The tracheid message needs
50  * to matched to a profile message with the closest frame number in order to import spot X data.
51  * Since the tracheid and profile messages contains batched data, the tracheid message may
52  * overlap with two profile messages. The messages are cloned into internal objects. As such,
53  * the GoProfilePointCloudMsg and GoTracheidMsg objects are still owned by the calling function
54  * and must be destroyed by it.
55  *
56  * @public @memberof GoWebScanTracheidInputMsg
57  * @param msg GoWebScanTracheidInputMsg object.
58  * @param deviceId Serial number of device from which tracheid message originates.
59  * @param tracheidStampMsg Tracheid message stamp.
60  * @param tracheidMsg Tracheid message.
61  * @param profileStampMsg0 Stamp of first matching candidate profile message.
62  * @param profileMsg0 First matching candidate profile message.
63  * @param profileStampMsg1 Stamp of second matching candidate profile message.
64  * @param profileMsg1 Second matching candidate profile message.
65  * @param config System configuration.
66  * @return Operation status.
67  */
68 GoWebScanFx(kStatus) GoWebScanTracheidInputMsg_Import(GoWebScanTracheidInputMsg msg, k32s deviceId, GoStampMsg tracheidStampMsg, GoTracheidMsg tracheidMsg,
69  GoStampMsg profileStampMsg0, GoProfilePointCloudMsg profileMsg0, GoStampMsg profileStampMsg1, GoProfilePointCloudMsg profileMsg1, GoWebScanConfig config);
70 
71 /**
72 * Gets the size, in bytes, of the tracheid data buffer.
73 *
74 * @public @memberof GoWebScanTracheidInputMsg
75 * @param msg GoWebScanTracheidInputMsg object.
76 * @return Buffer size (bytes).
77 */
78 GoWebScanFx(kSize) GoWebScanTracheidInputMsg_Size(GoWebScanTracheidInputMsg msg);
79 
80 /**
81 * Gets the count of tracheid arrays in this message.
82 *
83 * @public @memberof GoWebScanTracheidInputMsg
84 * @param msg GoWebScanTracheidInputMsg object.
85 * @return Tracheid array count.
86 */
87 GoWebScanFx(kSize) GoWebScanTracheidInputMsg_Count(GoWebScanTracheidInputMsg msg);
88 
89 /**
90 * Gets the width of tracheid arrays in this message
91 *
92 * @public @memberof GoWebScanTracheidInputMsg
93 * @param msg GoWebScanTracheidInputMsg object.
94 * @return Tracheid array width.
95 */
96 GoWebScanFx(kSize) GoWebScanTracheidInputMsg_Width(GoWebScanTracheidInputMsg msg);
97 
98 /**
99 * Gets a pointer to the message attributes for a tracheid array.
100 *
101 * @public @memberof GoWebScanTracheidInputMsg
102 * @param msg GoWebScanTracheidInputMsg object.
103 * @param rowIndex Tracheid message index.
104 * @return Pointer to tracheid message attributes.
105 */
106 GoWebScanFx(GoWebScanInputAttr*) GoWebScanTracheidInputMsg_AttrAt(GoWebScanTracheidInputMsg msg, kSize rowIndex);
107 
108 /**
109 * Gets a pointer to the start of a tracheid array at a given index.
110 *
111 * @public @memberof GoWebScanTracheidInputMsg
112 * @param msg GoWebScanTracheidInputMsg object.
113 * @param rowIndex Tracheid message index.
114 * @return Pointer to tracheid array.
115 */
116 GoWebScanFx(GoWebScanTracheidPoint*) GoWebScanTracheidInputMsg_DataAt(GoWebScanTracheidInputMsg msg, kSize rowIndex);
117 
118 kEndHeader()
119 #include <GoWebScanSdk/GoWebScanTracheidInputMsg.x.h>
120 
121 #endif
122 
Represents a tracheid point, which is the integer tracheid data for a spot with the X position (mils)...
Definition: GoWebScanSdkDef.h:553
kSize GoWebScanTracheidInputMsg_Width(GoWebScanTracheidInputMsg msg)
Gets the width of tracheid arrays in this message.
kStatus GoWebScanTracheidInputMsg_Construct(GoWebScanTracheidInputMsg *msg, GoWebScanPipeMsgPool pool, kAlloc allocator)
Constructs a GoWebScanTracheidInputMsg object.
kStatus GoWebScanTracheidInputMsg_Import(GoWebScanTracheidInputMsg msg, k32s deviceId, GoStampMsg tracheidStampMsg, GoTracheidMsg tracheidMsg, GoStampMsg profileStampMsg0, GoProfilePointCloudMsg profileMsg0, GoStampMsg profileStampMsg1, GoProfilePointCloudMsg profileMsg1, GoWebScanConfig config)
Imports a GoTracheidMsg into a GoWebScanTracheidInputMsg object.
Declares the GoWebScanPipeMsg class.
Essential GoWebScan declarations.
kStatus GoWebScanTracheidInputMsg_Destroy(GoWebScanTracheidInputMsg msg)
Destroys a GoWebScanTracheidInputMsg object.
GoWebScanInputAttr * GoWebScanTracheidInputMsg_AttrAt(GoWebScanTracheidInputMsg msg, kSize rowIndex)
Gets a pointer to the message attributes for a tracheid array.
Represents a message containing a raw tracheid message from a sensor.
kSize GoWebScanTracheidInputMsg_Count(GoWebScanTracheidInputMsg msg)
Gets the count of tracheid arrays in this message.
Represents the attributes of an input GoWebScan message object. These values are copied from the raw ...
Definition: GoWebScanSdkDef.h:522
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...
GoWebScanTracheidPoint * GoWebScanTracheidInputMsg_DataAt(GoWebScanTracheidInputMsg msg, kSize rowIndex)
Gets a pointer to the start of a tracheid array at a given index.
Represents a container for system-level parameters which are translated from user parameters set in G...
kSize GoWebScanTracheidInputMsg_Size(GoWebScanTracheidInputMsg msg)
Gets the size, in bytes, of the tracheid data buffer.
Declares a GoWebScanConfig object.