GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanCalCollector.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanCalCollector.h
3 * @brief Declares a GoWebScanCalCollector 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_COLLECTOR_H
12 #define GO_WEB_SCAN_CAL_COLLECTOR_H
13 
14 
18 #include <GoSdk/GoSdk.h>
19 
20 kBeginHeader()
21 
22 /**
23 * @class GoWebScanCalCollector
24 * @extends kObject
25 * @ingroup GoWebScanSdk-Calibration
26 * @brief Represents a task to coordinate collection of sensor messages, matching of messages in Y to
27 * produce system tiles, and detection of the calibration bar during system calibration. Sensor
28 * messages should be given to this class until the class has determined the calibration bar
29 * has been detected. At that point, a calibration input dataset is generated which contains
30 * system tiles containing the calibration bar, and this datset can be provided to the
31 * calibration processor (GoWebScanCalProcessor). The class coordinates combining messages
32 * to form Y-matched tiles via the GoWebScanCalCombiner algorithm, and detects the bar
33 * via the GoWebScanCalDetector algorithm.
34 * @see GoWebScanCalProcessor, GoWebScanCalCombiner, GoWebScanCalDetector
35 */
37 
38 /**
39  * Constructs a GoWebScanCalCollector object.
40  *
41  * @public @memberof GoWebScanCalCollector
42  * @param collector Receives the constructed GoWebScanCalCollector object.
43  * @param config System configuration.
44  * @param allocator Memory allocator (or kNULL for default).
45  * @return Operation status.
46  */
47 GoWebScanFx(kStatus) GoWebScanCalCollector_Construct(GoWebScanCalCollector* collector, GoWebScanConfig config, kAlloc allocator);
48 
49 /**
50  * Adds a sensor message to the collector. The messages are cloned into internal message
51  * objects. As such, the GoDataSet object is still owned by the calling function and must be
52  * destroyed by it.
53  *
54  * @public @memberof GoWebScanCalCollector
55  * @param collector GoWebScanCalCollector object.
56  * @param dataSet Input sensor message.
57  * @return Operation status.
58  */
59 GoWebScanFx(kStatus) GoWebScanCalCollector_AddMsg(GoWebScanCalCollector collector, GoDataSet dataSet);
60 
61 /**
62  * Gets a flag for whether the calibration collector has completed collection of sensor messages.
63  *
64  * @public @memberof GoWebScanCalCollector
65  * @param collector GoWebScanCalCollector object.
66  * @return Flag representing whether collection completed.
67  */
68 GoWebScanFx(kBool) GoWebScanCalCollector_IsCompleted(GoWebScanCalCollector collector);
69 
70 /**
71 * Gets a flag for whether the calibration collector had any errors during collection.
72 *
73 * @public @memberof GoWebScanCalCollector
74 * @param collector GoWebScanCalCollector object.
75 * @return Flag representing whether any errors are present.
76 */
77 GoWebScanFx(kBool) GoWebScanCalCollector_HasErrors(GoWebScanCalCollector collector);
78 
79 /**
80  * Gets a pointer to the calibration input file that can be provided to the calibration
81  * processor for processing. Ownership of the calibration input is transferred to the calling
82  * function.
83  *
84  * @public @memberof GoWebScanCalCollector
85  * @param collector GoWebScanCalCollector object.
86  * @param data Receives the constructed GoWebScanCalInput object.
87  * @return Operation status.
88  */
89 GoWebScanFx(kStatus) GoWebScanCalCollector_GetProcessorData(GoWebScanCalCollector collector, GoWebScanCalInput* data);
90 
91 kEndHeader()
92 #include <GoWebScanSdk/GoWebScanCalCollector.x.h>
93 
94 #endif
Represents a task to coordinate collection of sensor messages, matching of messages in Y to produce s...
Declares a GoWebScanCalInput object.
kStatus GoWebScanCalCollector_GetProcessorData(GoWebScanCalCollector collector, GoWebScanCalInput *data)
Gets a pointer to the calibration input file that can be provided to the calibration processor for pr...
Essential GoWebScan declarations.
Represents Y-matched system data containing a calibration bar, used for calibration processing...
kBool GoWebScanCalCollector_HasErrors(GoWebScanCalCollector collector)
Gets a flag for whether the calibration collector had any errors during collection.
kStatus GoWebScanCalCollector_Construct(GoWebScanCalCollector *collector, GoWebScanConfig config, kAlloc allocator)
Constructs a GoWebScanCalCollector object.
kStatus GoWebScanCalCollector_AddMsg(GoWebScanCalCollector collector, GoDataSet dataSet)
Adds a sensor message to the collector.
kBool GoWebScanCalCollector_IsCompleted(GoWebScanCalCollector collector)
Gets a flag for whether the calibration collector has completed collection of sensor messages...
Represents a container for system-level parameters which are translated from user parameters set in G...
Declares a GoWebScanConfig object.