GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanSyncTask.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanSyncTask.h
3 * @brief Declares a GoWebScanSyncTask 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_SYNC_TASK_H
12 #define GO_WEB_SCAN_SYNC_TASK_H
13 
18 
19 kBeginHeader()
20 
21 /**
22 * @class GoWebScanSyncTask
23 * @extends kObject
24 * @ingroup GoWebScanSdk-Control
25 * @brief Represents a task to match profile, vision, and tracheid tiles by Y-position and
26 * monitor for time and distance coherency violations.
27 *
28 * A GoWebScanSyncTask object receives tiles corresponding to the profile, presence,
29 * vision, and tracheid data from all individual cameras. Tiles are matched by
30 * Y-position, and then emitted in lists corresponding to the profile, presence,
31 * vision, and tracheid data in the top and/or bottom groups. The task receives
32 * GoWebScanProfileTileMsg, GoWebScanVisionTileMsg, and GoWebScanTracheidTileMsg
33 * objects and outputs GoWebScanTileListMsg objects for each data type. A GoWebScanSyncTask
34 * instance delegates most of its work to the GoWebScanTileCombiner algorithm.
35 * Incoming messages are passed directly to the GoWebScanTileCombiner instance, and
36 * outputs from the GoWebScanTileCombiner are immediately emitted as outputs from the
37 * GoWebScanSyncTask.
38 */
40 
41 // Forward declaration
43 
44 /**
45  * Constructs a GoWebScanSyncTask object.
46  *
47  * @public @memberof GoWebScanSyncTask
48  * @param task Receives the constructed GoWebScanSyncTask object.
49  * @param process Associated GoWebScanProcess object.
50  * @param config System configuration.
51  * @param allocator Memory allocator (or kNULL for default).
52  * @return Operation status.
53  */
54 GoWebScanFx(kStatus) GoWebScanSyncTask_Construct(GoWebScanSyncTask* task, GoWebScanProcess process, GoWebScanConfig config, kAlloc allocator);
55 
56 /**
57  * Sets the handler for receiving synced tile sets for each data type and plane.
58  *
59  * @public @memberof GoWebScanSyncTask
60  * @param task GoWebScanSyncTask object.
61  * @param id Message type ID.
62  * @param plane System plane.
63  * @param send Callback function.
64  * @param context Receiver argument for callback.
65  * @return Operation status.
66  */
67 GoWebScanFx(kStatus) GoWebScanSyncTask_SetReceiver(GoWebScanSyncTask task, GoWebScanSyncId id, GoWebScanSystemPlane plane, GoWebScanPipeSendFx send, kPointer context);
68 
69 /**
70 * Adds a message to the processing queue. Dequeues a message at the end of the queue to submit
71 * to the pipe for scheduling if no other job is currently pending.
72 *
73 * @public @memberof GoWebScanSyncTask
74 * @param task GoWebScanSyncTask object.
75 * @param msg Profile input message to enqueue.
76 * @return Operation status.
77 */
78 GoWebScanFx(kStatus) GoWebScanSyncTask_Send(GoWebScanSyncTask task, GoWebScanPipeMsg msg);
79 
80 /**
81 * Clears the tile combiner algorithm and resets internal variables.
82 *
83 * @public @memberof GoWebScanSyncTask
84 * @param task GoWebScanSyncTask object.
85 * @return Operation status.
86 */
87 GoWebScanFx(kStatus) GoWebScanSyncTask_Clear(GoWebScanSyncTask task);
88 
89 kEndHeader()
90 #include <GoWebScanSdk/GoWebScanSyncTask.x.h>
91 
92 #endif
Declares the GoWebScanPipeTask class.
Represents a task for processing raw sensor data to produce system web tiles (Web mode) or detected o...
Declares a GoWebScanPipe object.
kStatus(kCall * GoWebScanPipeSendFx)(kPointer context, GoWebScanPipeMsg msg)
Defines the signature of the handler used by tasks to receive a message from the pipe.
Definition: GoWebScanPipe.h:35
Represents an ID for types of sync list messages.
kStatus GoWebScanSyncTask_Construct(GoWebScanSyncTask *task, GoWebScanProcess process, GoWebScanConfig config, kAlloc allocator)
Constructs a GoWebScanSyncTask object.
Essential GoWebScan declarations.
Represents a task to match profile, vision, and tracheid tiles by Y-position and monitor for time and...
kStatus GoWebScanSyncTask_SetReceiver(GoWebScanSyncTask task, GoWebScanSyncId id, GoWebScanSystemPlane plane, GoWebScanPipeSendFx send, kPointer context)
Sets the handler for receiving synced tile sets for each data type and plane.
kStatus GoWebScanSyncTask_Clear(GoWebScanSyncTask task)
Clears the tile combiner algorithm and resets internal variables.
Represents the top or bottom plane of the system.
kStatus GoWebScanSyncTask_Send(GoWebScanSyncTask task, GoWebScanPipeMsg msg)
Adds a message to the processing queue.
Base class for a msg that can be processed with a GoWebScanPipeTask and submitted to the GoWebScanPip...
Represents a container for system-level parameters which are translated from user parameters set in G...
Declares a GoWebScanConfig object.