GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanCalInputNode.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanCalInputNode.h
3 * @brief Declares a GoWebScanCalInputNode 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_NODE_H
12 #define GO_WEB_SCAN_CAL_INPUT_NODE_H
13 
16 
17 kBeginHeader()
18 
19 /**
20 * @class GoWebScanCalInputNode
21 * @extends kObject
22 * @ingroup GoWebScanSdk-Calibration
23 * @brief Represents a container for raw sensor messages of a particular data type
24 * from a single node for calibration processing. An X section of the calibration
25 * bar corresponding to this node is contained in the messages.
26 */
28 
29 // Forward declaration
31 
32 /**
33  * Constructs a GoWebScanCalInputNode object.
34  *
35  * @public @memberof GoWebScanCalInputNode
36  * @param node Receives the constructed GoWebScanCalInputNode object.
37  * @param source Data source
38  * @param plane System plane.
39  * @param column Node column index.
40  * @param allocator Memory allocator (or kNULL for default).
41  * @return Operation status.
42  */
43 GoWebScanFx(kStatus) GoWebScanCalInputNode_Construct(GoWebScanCalInputNode* node, GoWebScanDataSource source, GoWebScanSystemPlane plane, k32s column, kAlloc allocator);
44 
45 /**
46  * Adds sensor message data, contained in a GoWebScanCalInputItem object, to the node input.
47  *
48  * @public @memberof GoWebScanCalInputNode
49  * @param node GoWebScanCalInputNode object.
50  * @param item Input item.
51  * @return Operation status.
52  */
53 GoWebScanFx(kStatus) GoWebScanCalInputNode_AddItem(GoWebScanCalInputNode node, GoWebScanCalInputItem* item);
54 
55 /**
56  * Gets the count of item messages in the node input.
57  *
58  * @public @memberof GoWebScanCalInputNode
59  * @param node GoWebScanCalInputNode object.
60  * @return Number of item messages.
61  */
62 GoWebScanFx(kSize) GoWebScanCalInputNode_ItemCount(GoWebScanCalInputNode node);
63 
64 /**
65  * Gets the item message at a specific index in the node input.
66  *
67  * @public @memberof GoWebScanCalInputNode
68  * @param node GoWebScanCalInputNode object.
69  * @param index Item index.
70  * @return Item count.
71  */
72 GoWebScanFx(GoWebScanCalInputItem) GoWebScanCalInputNode_ItemAt(GoWebScanCalInputNode node, kSize index);
73 
74 /**
75 * Gets the system plane of the node input.
76 *
77 * @public @memberof GoWebScanCalInputNode
78 * @param node GoWebScanCalInputNode object.
79 * @return System plane.
80 */
81 GoWebScanFx(GoWebScanSystemPlane) GoWebScanCalInputNode_Plane(GoWebScanCalInputNode node);
82 
83 /**
84 * Gets the node column index of the node input.
85 *
86 * @public @memberof GoWebScanCalInputNode
87 * @param node GoWebScanCalInputNode object.
88 * @return Node column index.
89 */
90 GoWebScanFx(k32s) GoWebScanCalInputNode_Column(GoWebScanCalInputNode node);
91 
92 /**
93  * Sets the number of dropped frames in the node input.
94  *
95  * @public @memberof GoWebScanCalInputNode
96  * @param node GoWebScanCalInputNode object.
97  * @param dropCount Number of dropped frames.
98  * @return Operation status.
99  */
100 GoWebScanFx(kStatus) GoWebScanCalInputNode_SetFrameDropCount(GoWebScanCalInputNode node, k64s dropCount);
101 
102 /**
103 * Gets the number of dropped frames in the node input.
104 *
105 * @public @memberof GoWebScanCalInputNode
106 * @param node GoWebScanCalInputNode object.
107 * @return Number of dropped frames.
108 */
109 GoWebScanFx(k64s) GoWebScanCalInputNode_FrameDropCount(GoWebScanCalInputNode node);
110 
111 /**
112 * Sets the number of times the node has been disabled due to dropped or latent frames.
113 *
114 * @public @memberof GoWebScanCalInputNode
115 * @param node GoWebScanCalInputNode object.
116 * @param disableCount Number of disables.
117 * @return Operation status.
118 */
119 GoWebScanFx(kStatus) GoWebScanCalInputNode_SetDisableCount(GoWebScanCalInputNode node, k64s disableCount);
120 
121 /**
122 * Gets the number of times the node has been disabled due to dropped or latent frames.
123 *
124 * @public @memberof GoWebScanCalInputNode
125 * @param node GoWebScanCalInputNode object.
126 * @return Number of disables.
127 */
128 GoWebScanFx(k64s) GoWebScanCalInputNode_DisableCount(GoWebScanCalInputNode node);
129 
130 kEndHeader()
131 #include <GoWebScanSdk/GoWebScanCalInputNode.x.h>
132 
133 #endif
kStatus GoWebScanCalInputNode_SetFrameDropCount(GoWebScanCalInputNode node, k64s dropCount)
Sets the number of dropped frames in the node input.
kStatus GoWebScanCalInputNode_SetDisableCount(GoWebScanCalInputNode node, k64s disableCount)
Sets the number of times the node has been disabled due to dropped or latent frames.
Represents a type of sensor data.
GoWebScanCalInputItem GoWebScanCalInputNode_ItemAt(GoWebScanCalInputNode node, kSize index)
Gets the item message at a specific index in the node input.
Essential GoWebScan declarations.
k64s GoWebScanCalInputNode_DisableCount(GoWebScanCalInputNode node)
Gets the number of times the node has been disabled due to dropped or latent frames.
GoWebScanSystemPlane GoWebScanCalInputNode_Plane(GoWebScanCalInputNode node)
Gets the system plane of the node input.
kStatus GoWebScanCalInputNode_Construct(GoWebScanCalInputNode *node, GoWebScanDataSource source, GoWebScanSystemPlane plane, k32s column, kAlloc allocator)
Constructs a GoWebScanCalInputNode object.
kSize GoWebScanCalInputNode_ItemCount(GoWebScanCalInputNode node)
Gets the count of item messages in the node input.
k64s GoWebScanCalInputNode_FrameDropCount(GoWebScanCalInputNode node)
Gets the number of dropped frames in the node input.
Represents a raw sensor message used for calibration collection and processing.
Represents a container for raw sensor messages of a particular data type from a single node for calib...
Declares a GoWebScanCalInputItem object.
Represents the top or bottom plane of the system.
kStatus GoWebScanCalInputNode_AddItem(GoWebScanCalInputNode node, GoWebScanCalInputItem *item)
Adds sensor message data, contained in a GoWebScanCalInputItem object, to the node input...
k32s GoWebScanCalInputNode_Column(GoWebScanCalInputNode node)
Gets the node column index of the node input.