GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanVisionInputMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanVisionInputMsg.h
3 * @brief Declares a GoWebScanVisionInputMsg 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_INPUT_MSG_H
11 #define GO_SCANNER_VISION_INPUT_MSG_H
12 
17 #include <GoSdk/GoSdk.h>
18 
19 kBeginHeader()
20 
21 /**
22 * @class GoWebScanVisionInputMsg
23 * @extends GoWebScanPipeMsg
24 * @ingroup GoWebScanSdk-Messages
25 * @brief Represents a message containing a raw vision message from a sensor.
26 */
28 
29 /**
30 * Constructs a GoWebScanVisionInputMsg object.
31 *
32 * @public @memberof GoWebScanVisionInputMsg
33 * @param msg Receives the constructed GoWebScanVisionInputMsg object.
34 * @param pool Message pool of GoWebScanVisionInputMsg objects
35 * @param allocator Memory allocator (or kNULL for default).
36 * @return Operation status.
37 */
38 GoWebScanFx(kStatus) GoWebScanVisionInputMsg_Construct(GoWebScanVisionInputMsg* msg, GoWebScanPipeMsgPool pool, kAlloc allocator);
39 
40 /**
41 * Destroys a GoWebScanVisionInputMsg object.
42 *
43 * @public @memberof GoWebScanVisionInputMsg
44 * @param msg GoWebScanVisionInputMsg object.
45 * @return Operation status.
46 */
47 GoWebScanFx(kStatus) GoWebScanVisionInputMsg_Destroy(GoWebScanVisionInputMsg msg);
48 
49 /**
50 * Imports a GoVideoMsg msg into a GoWebScanVisionInputMsg object. The messages are cloned into
51 * internal objects. As such, the GoVideoMsg object is still owned by the calling function and
52 * must be destroyed by it.
53 *
54 * @public @memberof GoWebScanVisionInputMsg
55 * @param msg GoWebScanVisionInputMsg object.
56 * @param deviceId Serial number of device from which message originates.
57 * @param stampMsg Message stamp.
58 * @param visionMsg Video message.
59 * @param configNode Node configuration.
60 * @return Operation status.
61 */
62 GoWebScanFx(kStatus) GoWebScanVisionInputMsg_Import(GoWebScanVisionInputMsg msg, k32s deviceId, GoStampMsg stampMsg, GoVideoMsg visionMsg, GoWebScanConfigNode configNode);
63 
64 /**
65 * Gets the size, in bytes, of the vision data buffer.
66 *
67 * @public @memberof GoWebScanVisionInputMsg
68 * @param msg GoWebScanVisionInputMsg object.
69 * @return Buffer size (bytes).
70 */
71 GoWebScanFx(kSize) GoWebScanVisionInputMsg_Size(GoWebScanVisionInputMsg msg);
72 
73 /**
74 * Gets the height of the message.
75 *
76 * @public @memberof GoWebScanVisionInputMsg
77 * @param msg GoWebScanVisionInputMsg object.
78 * @return Message height.
79 */
80 GoWebScanFx(kSize) GoWebScanVisionInputMsg_Height(GoWebScanVisionInputMsg msg);
81 
82 /**
83 * Gets the width of the message
84 *
85 * @public @memberof GoWebScanVisionInputMsg
86 * @param msg GoWebScanVisionInputMsg object.
87 * @return Message width.
88 */
89 GoWebScanFx(kSize) GoWebScanVisionInputMsg_Width(GoWebScanVisionInputMsg msg);
90 
91 /**
92 * Gets the image stored in the message.
93 *
94 * @public @memberof GoWebScanVisionInputMsg
95 * @param msg GoWebScanVisionInputMsg object.
96 * @return Message image.
97 */
98 GoWebScanFx(kImage) GoWebScanVisionInputMsg_Data(GoWebScanVisionInputMsg msg);
99 
100 /**
101 * Gets a pointer to the start of an image row.
102 *
103 * @public @memberof GoWebScanVisionInputMsg
104 * @param msg GoWebScanVisionInputMsg object.
105 * @param index Row index.
106 * @return Pointer to start of image row.
107 */
108 GoWebScanFx(k8u*) GoWebScanVisionInputMsg_DataAt(GoWebScanVisionInputMsg msg, kSize index);
109 
110 kEndHeader()
111 #include <GoWebScanSdk/GoWebScanVisionInputMsg.x.h>
112 
113 #endif
114 
Represents a container for node-level parameters which are translated from user parameters set in GoW...
kStatus GoWebScanVisionInputMsg_Construct(GoWebScanVisionInputMsg *msg, GoWebScanPipeMsgPool pool, kAlloc allocator)
Constructs a GoWebScanVisionInputMsg object.
Declares the GoWebScanPipeMsg class.
Essential GoWebScan declarations.
Represents a message containing a raw vision message from a sensor.
kStatus GoWebScanVisionInputMsg_Import(GoWebScanVisionInputMsg msg, k32s deviceId, GoStampMsg stampMsg, GoVideoMsg visionMsg, GoWebScanConfigNode configNode)
Imports a GoVideoMsg msg into a GoWebScanVisionInputMsg object.
kSize GoWebScanVisionInputMsg_Width(GoWebScanVisionInputMsg msg)
Gets the width of the message.
Declares a GoWebScanConfigNode object.
k8u * GoWebScanVisionInputMsg_DataAt(GoWebScanVisionInputMsg msg, kSize index)
Gets a pointer to the start of an image row.
kSize GoWebScanVisionInputMsg_Height(GoWebScanVisionInputMsg msg)
Gets the height of the message.
kStatus GoWebScanVisionInputMsg_Destroy(GoWebScanVisionInputMsg msg)
Destroys a GoWebScanVisionInputMsg object.
kImage GoWebScanVisionInputMsg_Data(GoWebScanVisionInputMsg msg)
Gets the image stored in the message.
kSize GoWebScanVisionInputMsg_Size(GoWebScanVisionInputMsg msg)
Gets the size, in bytes, of the vision data buffer.
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...
Declares a GoWebScanConfig object.