GoWebScan API
GoWebScanCalCollector Class Reference

Description

Represents a task to coordinate collection of sensor messages, matching of messages in Y to produce system tiles, and detection of the calibration bar during system calibration. Sensor messages should be given to this class until the class has determined the calibration bar has been detected. At that point, a calibration input dataset is generated which contains system tiles containing the calibration bar, and this dataset can be provided to the calibration processor (GoWebScanCalProcessor). The class coordinates combining messages to form Y-matched tiles via the GoWebScanCalCombiner algorithm, and detects the bar via the GoWebScanCalDetector algorithm.

See also
GoWebScanCalProcessor, GoWebScanCalCombiner, GoWebScanCalDetector
Inheritance diagram for GoWebScanCalCollector:
Inheritance graph

Public Member Functions

kStatus GoWebScanCalCollector_AddMsg (GoWebScanCalCollector collector, GoDataSet dataSet)
 Adds a sensor message to the collector. More...
 
kStatus GoWebScanCalCollector_CheckFrameDrops (GoWebScanCalCollector collector, kBool enable)
 Enable or disable frame drop check. More...
 
kStatus GoWebScanCalCollector_Construct (GoWebScanCalCollector *collector, GoWebScanConfig config, kAlloc allocator)
 Constructs a GoWebScanCalCollector object. More...
 
kStatus GoWebScanCalCollector_Flush (GoWebScanCalCollector collector)
 Flush any existing sensor messages currently in the pipeline. More...
 
kBool GoWebScanCalCollector_FrameDropsChecked (GoWebScanCalCollector collector)
 Get value for whether or not frame drops are checked. More...
 
kStatus GoWebScanCalCollector_GetCalRecording (GoWebScanCalCollector collector, GoWebScanRecording *recording)
 Gets a pointer to the recording of sensor message sets used to perform calibration. More...
 
kStatus GoWebScanCalCollector_GetProcessorData (GoWebScanCalCollector collector, GoWebScanCalInput *data)
 Gets a pointer to the calibration input file that can be provided to the calibration processor for processing. More...
 
kBool GoWebScanCalCollector_HasErrors (GoWebScanCalCollector collector)
 Gets a flag for whether the calibration collector had any errors during collection. More...
 
kBool GoWebScanCalCollector_IsCompleted (GoWebScanCalCollector collector)
 Gets a flag for whether the calibration collector has completed collection of sensor messages. More...
 
kBool GoWebScanCalCollector_Reset (GoWebScanCalCollector collector)
 Reset the collector to its original state. More...
 
kStatus GoWebScanCalCollector_SetOnCompleteHandler (GoWebScanCalCollector collector, GoWebScanCalCollectorCompleteFx function, kPointer receiver)
 Sets a callback function for when the calibration collector has completed collection of sensor messages. More...
 

The documentation for this class was generated from the following file: