GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanProfileInputMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanProfileInputMsg.h
3 * @brief Declares a GoWebScanProfileInputMsg 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_INPUT_MSG_H
11 #define GO_SCANNER_PROFILE_INPUT_MSG_H
12 
16 #include <GoSdk/GoSdk.h>
17 
18 kBeginHeader()
19 
20 /**
21 * @class GoWebScanProfileInputMsg
22 * @extends GoWebScanPipeMsg
23 * @ingroup GoWebScanSdk-Messages
24 * @brief Represents a message containing a raw profile message from a sensor.
25 */
27 
28 /**
29 * Constructs a GoWebScanProfileInputMsg object.
30 *
31 * @public @memberof GoWebScanProfileInputMsg
32 * @param msg Receives the constructed GoWebScanProfileInputMsg object.
33 * @param pool Message pool of GoWebScanProfileInputMsg objects
34 * @param allocator Memory allocator (or kNULL for default).
35 * @return Operation status.
36 */
37 GoWebScanFx(kStatus) GoWebScanProfileInputMsg_Construct(GoWebScanProfileInputMsg* msg, GoWebScanPipeMsgPool pool, kAlloc allocator);
38 
39 /**
40 * Destroys a GoWebScanProfileInputMsg object.
41 *
42 * @public @memberof GoWebScanProfileInputMsg
43 * @param msg GoWebScanProfileInputMsg object.
44 * @return Operation status.
45 */
46 GoWebScanFx(kStatus) GoWebScanProfileInputMsg_Destroy(GoWebScanProfileInputMsg msg);
47 
48 /**
49  * Imports a GoProfilePointCloudMsg msg into a GoWebScanProfileInputMsg object. The messages are
50  * cloned into internal objects. As such, the GoProfilePointCloudMsg object is still owned by the
51  * calling function and must be destroyed by it.
52  *
53  * @public @memberof GoWebScanProfileInputMsg
54  * @param msg GoWebScanProfileInputMsg object.
55  * @param deviceId Serial number of device from which message originates.
56  * @param stampMsg Message stamp.
57  * @param profileMsg Profile message.
58  * @param config System configuration.
59  * @return Operation status.
60  */
61 GoWebScanFx(kStatus) GoWebScanProfileInputMsg_Import(GoWebScanProfileInputMsg msg, k32s deviceId, GoStampMsg stampMsg, GoProfilePointCloudMsg profileMsg, GoWebScanConfig config);
62 
63 /**
64 * Gets the size, in bytes, of the profile data buffer.
65 *
66 * @public @memberof GoWebScanProfileInputMsg
67 * @param msg GoWebScanProfileInputMsg object.
68 * @return Buffer size (bytes).
69 */
70 GoWebScanFx(kSize) GoWebScanProfileInputMsg_Size(GoWebScanProfileInputMsg msg);
71 
72 /**
73 * Gets the count of profile arrays in this message.
74 *
75 * @public @memberof GoWebScanProfileInputMsg
76 * @param msg GoWebScanProfileInputMsg object.
77 * @return Profile array count.
78 */
79 GoWebScanFx(kSize) GoWebScanProfileInputMsg_Count(GoWebScanProfileInputMsg msg);
80 
81 /**
82 * Gets the width of profile arrays in this message
83 *
84 * @public @memberof GoWebScanProfileInputMsg
85 * @param msg GoWebScanProfileInputMsg object.
86 * @return Profile array width.
87 */
88 GoWebScanFx(kSize) GoWebScanProfileInputMsg_Width(GoWebScanProfileInputMsg msg);
89 
90 /**
91 * Gets a pointer to the message attributes for a profile array.
92 *
93 * @public @memberof GoWebScanProfileInputMsg
94 * @param msg GoWebScanProfileInputMsg object.
95 * @param rowIndex Profile message index.
96 * @return Pointer to profile message attributes.
97 */
98 GoWebScanFx(GoWebScanInputAttr*) GoWebScanProfileInputMsg_AttrAt(GoWebScanProfileInputMsg msg, kSize rowIndex);
99 
100 /**
101 * Gets a pointer to the start of a profile array at a given index.
102 *
103 * @public @memberof GoWebScanProfileInputMsg
104 * @param msg GoWebScanProfileInputMsg object.
105 * @param rowIndex Profile message index.
106 * @return Pointer to profile array.
107 */
108 GoWebScanFx(kPoint16s*) GoWebScanProfileInputMsg_DataAt(GoWebScanProfileInputMsg msg, kSize rowIndex);
109 
110 kEndHeader()
111 #include <GoWebScanSdk/GoWebScanProfileInputMsg.x.h>
112 
113 #endif
114 
kStatus GoWebScanProfileInputMsg_Destroy(GoWebScanProfileInputMsg msg)
Destroys a GoWebScanProfileInputMsg object.
kSize GoWebScanProfileInputMsg_Count(GoWebScanProfileInputMsg msg)
Gets the count of profile arrays in this message.
Represents a message containing a raw profile message from a sensor.
kPoint16s * GoWebScanProfileInputMsg_DataAt(GoWebScanProfileInputMsg msg, kSize rowIndex)
Gets a pointer to the start of a profile array at a given index.
kStatus GoWebScanProfileInputMsg_Construct(GoWebScanProfileInputMsg *msg, GoWebScanPipeMsgPool pool, kAlloc allocator)
Constructs a GoWebScanProfileInputMsg object.
Declares the GoWebScanPipeMsg class.
Essential GoWebScan declarations.
kSize GoWebScanProfileInputMsg_Width(GoWebScanProfileInputMsg msg)
Gets the width of profile arrays in this message.
kStatus GoWebScanProfileInputMsg_Import(GoWebScanProfileInputMsg msg, k32s deviceId, GoStampMsg stampMsg, GoProfilePointCloudMsg profileMsg, GoWebScanConfig config)
Imports a GoProfilePointCloudMsg msg into a GoWebScanProfileInputMsg object.
Represents the attributes of an input GoWebScan message object. These values are copied from the raw ...
Definition: GoWebScanSdkDef.h:522
GoWebScanInputAttr * GoWebScanProfileInputMsg_AttrAt(GoWebScanProfileInputMsg msg, kSize rowIndex)
Gets a pointer to the message attributes for a profile array.
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 GoWebScanProfileInputMsg_Size(GoWebScanProfileInputMsg msg)
Gets the size, in bytes, of the profile data buffer.
Represents a container for system-level parameters which are translated from user parameters set in G...
Declares a GoWebScanConfig object.