GoWebScanSyncTask.h

Go to the documentation of this file.

/**
* @file    GoWebScanSyncTask.h
* @brief   Declares a GoWebScanSyncTask 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_SYNC_TASK_H
#define GO_WEB_SCAN_SYNC_TASK_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanPipe.h>
#include <GoWebScanSdk/GoWebScanPipeTask.h>
#include <GoWebScanSdk/GoWebScanConfig.h>
#include <GoWebScanSdk/GoWebScanTileCombiner.h>

/**
* @class   GoWebScanSyncTask
* @extends kObject
* @ingroup GoWebScanSdk-Control
* @brief   Represents a task to match profile, vision, and tracheid tiles by Y-position and
*          monitor for time and distance coherency violations.
*          
*          A GoWebScanSyncTask object receives tiles corresponding to the profile, presence, 
*          vision, and tracheid data from all individual cameras. Tiles are matched by 
*          Y-position, and then emitted in lists corresponding to the profile, presence, 
*          vision, and tracheid data in the top and/or bottom groups. The task receives
*          GoWebScanProfileTileMsg, GoWebScanVisionTileMsg, and GoWebScanTracheidTileMsg
*          objects and outputs GoWebScanTileListMsg objects for each data type. A GoWebScanSyncTask 
*          instance delegates most of its work to the GoWebScanTileCombiner algorithm. 
*          Incoming messages are passed directly to the GoWebScanTileCombiner instance, and 
*          outputs from the GoWebScanTileCombiner are immediately emitted as outputs from the 
*          GoWebScanSyncTask.
*/
typedef kObject GoWebScanSyncTask;

// Forward declaration
typedef kObject GoWebScanProcess;

/**
 * Constructs a GoWebScanSyncTask object.
 * 
 * @public              @memberof GoWebScanSyncTask
 * @param   task        Receives the constructed GoWebScanSyncTask object.
 * @param   process     Associated GoWebScanProcess object.
 * @param   config      System configuration.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSyncTask_Construct(GoWebScanSyncTask* task, GoWebScanProcess process, GoWebScanConfig config, kAlloc allocator);

/**
 * Sets the handler for receiving synced tile sets for each data type and plane.
 * 
 * @public          @memberof GoWebScanSyncTask
 * @param   task    GoWebScanSyncTask object.
 * @param   id      Message type ID.
 * @param   plane   System plane.
 * @param   send    Callback function.
 * @param   context Receiver argument for callback.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanSyncTask_SetReceiver(GoWebScanSyncTask task, GoWebScanSyncId id, GoWebScanSystemPlane plane, GoWebScanPipeSendFx send, kPointer context);

/**
* Adds a message to the processing queue. Dequeues a message at the end of the queue to submit
* to the pipe for scheduling if no other job is currently pending.
* 
* @public          @memberof GoWebScanSyncTask
* @param   task    GoWebScanSyncTask object.
* @param   msg     Profile input message to enqueue.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSyncTask_Send(GoWebScanSyncTask task, GoWebScanPipeMsg msg);

/**
* Clears the tile combiner algorithm and resets internal variables.
* 
* @public          @memberof GoWebScanSyncTask
* @param   task    GoWebScanSyncTask object.
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSyncTask_Clear(GoWebScanSyncTask task);

/**
* Set handler for when tile lane is disabled. Function calls for disabling or enabling a lane enter an asynchronous queue.
*
* @public                   @memberof GoWebScanSyncTask
* @param  task              GoWebScanSyncTask object.
* @param  function          Callback function.
* @param  receiver          Receiver argument for callback.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSyncTask_SetLaneDisabledHandler(GoWebScanSyncTask task, GoWebScanTileCombinerLaneChangeFx function, kPointer receiver);

/**
* Set handler for when tile lane is re-enabled. Function calls for disabling or enabling a lane enter an asynchronous queue.
*
* @public                   @memberof GoWebScanSyncTask
* @param  task              GoWebScanSyncTask object.
* @param  function          Callback function.
* @param  receiver          Receiver argument for callback.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSyncTask_SetLaneEnabledHandler(GoWebScanSyncTask task, GoWebScanTileCombinerLaneChangeFx function, kPointer receiver);

/**
* Update the system configuration.
*
* @public                   @memberof GoWebScanSyncTask
* @param  task              GoWebScanSyncTask object.
* @param config             System configuration.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanSyncTask_UpdateConfig(GoWebScanSyncTask task, GoWebScanConfig config);

#include <GoWebScanSdk/GoWebScanSyncTask.x.h>

#endif