GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanCalInputItem.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanCalInputItem.h
3 * @brief Declares a GoWebScanCalInputItem 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 
11 #ifndef GO_WEB_SCAN_CAL_INPUT_ITEM_H
12 #define GO_WEB_SCAN_CAL_INPUT_ITEM_H
13 
15 
16 kBeginHeader()
17 
18 /**
19 * @struct GoWebScanCalInputStamp
20 * @extends kValue
21 * @ingroup GoWebScanSdk-Calibration
22 * @brief Represents a stamp containing properties of the input message.
23 */
24 typedef struct GoWebScanCalInputStamp
25 {
26  GoWebScanDataSource source; ///< Data source of message.
27  GoWebScanSystemPlane plane; ///< System plane of message.
28  k32s column; ///< Node column index.
29  k32s deviceId; ///< Sensor ID. Profile ID for vision systems.
30  k32s bankId; ///< Bank index.
31  k64s position; ///< Y-axis position (mils).
32  k64s timeStamp; ///< Timestamp of message (internal units approximating microseconds). See GoStamp.
33  k64s frame; ///< Frame index.
34  k64s encoder; ///< Encoder value (ticks).
36 
37 /**
38 * @class GoWebScanCalInputItem
39 * @extends kObject
40 * @ingroup GoWebScanSdk-Calibration
41 * @brief Represents a raw sensor message used for calibration collection
42 * and processing.
43 */
45 
46 /**
47  * Constructs a GoWebScanCalInputItem object.
48  *
49  * @public @memberof GoWebScanCalInputItem
50  * @param item Receives the constructed GoWebScanCalInputItem object.
51  * @param allocator Memory allocator (or kNULL for default).
52  * @return Operation status.
53  */
55 
56 /**
57  * Clones a GoWebScanCalInputItem object.
58  *
59  * @public @memberof GoWebScanCalInputItem
60  * @param item GoWebScanCalInputItem object.
61  * @param clone Receives the constructed cloned GoWebScanCalInputItem object.
62  * @return Operation status.
63  */
65 
66 /**
67  * Sets the stamp for an input item.
68  *
69  * @public @memberof GoWebScanCalInputItem
70  * @param item GoWebScanCalInputItem object.
71  * @param stamp Stamp of input item.
72  * @return Operation status.
73  */
75 
76 /**
77 * Gets a pointer to the stamp for an input item.
78 *
79 * @public @memberof GoWebScanCalInputItem
80 * @param item GoWebScanCalInputItem object.
81 * @return Pointer to stamp of input item.
82 */
84 
85 /**
86  * Adds data to an input item. The class takes ownership of the data object.
87  *
88  * @public @memberof GoWebScanCalInputItem
89  * @param item GoWebScanCalInputItem object.
90  * @param data Message data.
91  * @return Operation status.
92  */
94 
95 /**
96 * Gets data of an input item. The class continues to own the data object.
97 *
98 * @public @memberof GoWebScanCalInputItem
99 * @param item GoWebScanCalInputItem object.
100 * @return Message data.
101 */
103 
104 kEndHeader()
105 #include <GoWebScanSdk/GoWebScanCalInputItem.x.h>
106 
107 #endif
k64s frame
Frame index.
Definition: GoWebScanCalInputItem.h:33
kStatus GoWebScanCalInputItem_Clone(GoWebScanCalInputItem item, GoWebScanCalInputItem *clone)
Clones a GoWebScanCalInputItem object.
kStatus GoWebScanCalInputItem_Construct(GoWebScanCalInputItem *item, kAlloc allocator)
Constructs a GoWebScanCalInputItem object.
k32s bankId
Bank index.
Definition: GoWebScanCalInputItem.h:30
kObject GoWebScanCalInputItem_Data(GoWebScanCalInputItem item)
Gets data of an input item.
GoWebScanSystemPlane plane
System plane of message.
Definition: GoWebScanCalInputItem.h:27
GoWebScanCalInputStamp * GoWebScanCalInputItem_GetStamp(GoWebScanCalInputItem item)
Gets a pointer to the stamp for an input item.
Represents a type of sensor data.
Essential GoWebScan declarations.
GoWebScanDataSource source
Data source of message.
Definition: GoWebScanCalInputItem.h:26
k64s timeStamp
Timestamp of message (internal units approximating microseconds). See GoStamp.
Definition: GoWebScanCalInputItem.h:32
k32s deviceId
Sensor ID. Profile ID for vision systems.
Definition: GoWebScanCalInputItem.h:29
Represents a raw sensor message used for calibration collection and processing.
kStatus GoWebScanCalInputItem_SetStamp(GoWebScanCalInputItem item, GoWebScanCalInputStamp *stamp)
Sets the stamp for an input item.
k32s column
Node column index.
Definition: GoWebScanCalInputItem.h:28
k64s encoder
Encoder value (ticks).
Definition: GoWebScanCalInputItem.h:34
Represents a stamp containing properties of the input message.
Definition: GoWebScanCalInputItem.h:24
Represents the top or bottom plane of the system.
kStatus GoWebScanCalInputItem_SetData(GoWebScanCalInputItem item, kObject data)
Adds data to an input item.
k64s position
Y-axis position (mils).
Definition: GoWebScanCalInputItem.h:31