GoWebScanCalCollector.h

Go to the documentation of this file.

/**
* @file    GoWebScanCalCollector.h
* @brief   Declares a GoWebScanCalCollector object.
*
* @internal
* Copyright (C) 2017-2026 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/

#ifndef GO_WEB_SCAN_CAL_COLLECTOR_H
#define GO_WEB_SCAN_CAL_COLLECTOR_H


#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanCalInput.h>
#include <GoWebScanSdk/GoWebScanConfig.h>
#include <GoWebScanSdk/GoWebScanRecording.h>
#include <GoSdk/GoSdk.h>

/**
* @class   GoWebScanCalCollector
* @extends kObject
* @ingroup GoWebScanSdk-Calibration
* @brief   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     GoWebScanCalProcessor, GoWebScanCalCombiner, GoWebScanCalDetector
*/
typedef kObject GoWebScanCalCollector;

/** Defines the signature for the handler for when the collector is complete. */
typedef kStatus(kCall* GoWebScanCalCollectorCompleteFx)(kPointer context);

/**
 * Constructs a GoWebScanCalCollector object.
 * 
 * @public              @memberof GoWebScanCalCollector
 * @param   collector   Receives the constructed GoWebScanCalCollector object.
 * @param   config      System configuration.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalCollector_Construct(GoWebScanCalCollector* collector, GoWebScanConfig config, kAlloc allocator);

/**
 * Adds a sensor message to the collector. The messages are cloned into internal message
 * objects. As such, the GoDataSet object is still owned by the calling function and must be
 * destroyed by it.
 * 
 * @public              @memberof GoWebScanCalCollector
 * @param   collector   GoWebScanCalCollector object.
 * @param   dataSet     Input sensor message.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalCollector_AddMsg(GoWebScanCalCollector collector, GoDataSet dataSet);

/**
 * Flush any existing sensor messages currently in the pipeline.
 *
 * @public              @memberof GoWebScanCalCollector
 * @param   collector   GoWebScanCalCollector object.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalCollector_Flush(GoWebScanCalCollector collector);

/**
 * Gets a flag for whether the calibration collector has completed collection of sensor messages.
 * 
 * @public              @memberof GoWebScanCalCollector
 * @param   collector   GoWebScanCalCollector object.
 * @return              Flag representing whether collection completed.
 */
GoWebScanFx(kBool) GoWebScanCalCollector_IsCompleted(GoWebScanCalCollector collector);

/**
* Gets a flag for whether the calibration collector had any errors during collection.
* 
* @public              @memberof GoWebScanCalCollector
* @param   collector   GoWebScanCalCollector object.
* @return              Flag representing whether any errors are present.
*/
GoWebScanFx(kBool) GoWebScanCalCollector_HasErrors(GoWebScanCalCollector collector);

/**
 * Gets a pointer to the calibration input file that can be provided to the calibration
 * processor for processing. Ownership of the calibration input is transferred to the calling
 * function.
 * 
 * @public              @memberof GoWebScanCalCollector
 * @param   collector   GoWebScanCalCollector object.
 * @param   data        Receives the constructed GoWebScanCalInput object.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalCollector_GetProcessorData(GoWebScanCalCollector collector, GoWebScanCalInput* data);

/**
 * Gets a pointer to the recording of sensor message sets used to perform calibration. Ownership of the 
 * calibration input is transferred to the calling function.
 *
 * @public              @memberof GoWebScanCalCollector
 * @param   collector   GoWebScanCalCollector object.
 * @param   recording   Receives the constructed GoWebScanRecording object.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalCollector_GetCalRecording(GoWebScanCalCollector collector, GoWebScanRecording* recording);

/**
 * Sets a callback function for when the calibration collector has completed collection of sensor messages.
 *
 * @public              @memberof GoWebScanCalCollector
 * @param   collector   GoWebScanCalCollector object.
 * @param   function    Data callback function (or kNULL to unregister).
 * @param   receiver    Receiver argument for callback.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalCollector_SetOnCompleteHandler(GoWebScanCalCollector collector, GoWebScanCalCollectorCompleteFx function, kPointer receiver);

/**
 * Enable or disable frame drop check.
 *
 * @public              @memberof GoWebScanCalCollector
 * @param   collector   GoWebScanCalCollector object.
 * @param   enable      Enable frame drop check.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalCollector_CheckFrameDrops(GoWebScanCalCollector collector, kBool enable);

/**
 * Get value for whether or not frame drops are checked.
 *
 * @public              @memberof GoWebScanCalCollector
 * @param   collector   GoWebScanCalCollector object.
 * @return              Boolean if frame drops are checked.
 */
GoWebScanFx(kBool) GoWebScanCalCollector_FrameDropsChecked(GoWebScanCalCollector collector);

/**
 * Reset the collector to its original state.
 *
 * @public              @memberof GoWebScanCalCollector
 * @param   collector   GoWebScanCalCollector object.
 * @return              Operation status.
 */
GoWebScanFx(kBool) GoWebScanCalCollector_Reset(GoWebScanCalCollector collector);

#include <GoWebScanSdk/GoWebScanCalCollector.x.h>

#endif