GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanWebTask.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanWebTask.h
3 * @brief Declares a GoWebScanWebTask 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_WEB_TASK_H
12 #define GO_WEB_SCAN_WEB_TASK_H
13 
18 
19 kBeginHeader()
20 
21 /**
22 * @class GoWebScanWebTask
23 * @extends kObject
24 * @ingroup GoWebScanSdk-Control
25 * @brief Represents a task for combining outputs from multiple Merge Tasks into a single
26 * GoWebScanSystemMsg object. No additional processing is performed. In Web Mode,
27 * this is the final stage before results are delivered back to the GoWebScanProcess
28 * object. In Detection mode, the output from GoWebScanWebTask is passed to
29 * GoWebScanDetectionTask for additional processing. The task accepts
30 * GoWebScanProfileTileMsg, GoWebScanVisionTileMsg, and GoWebScanTracheidTileMsg
31 * objects and outputs GoWebScanSystemMsg objects.
32 *
33 * Tiles are assembled using the GoWebScanTileCombiner algorithm. Tiles not are
34 * copied when creating a GoWebScanSystemMsg object. The reference count on the
35 * original tiles is incremented when they are added to a GoWebScanSystemMsg, and
36 * decremented when the GoWebScanSystemMsg is freed.
37 */
39 
40 // Forward declaration
42 
43 /**
44 * Constructs a GoWebScanWebTask object.
45 *
46 * @public @memberof GoWebScanWebTask
47 * @param task Receives the constructed GoWebScanWebTask object.
48 * @param process Associated GoWebScanProcess object which will receive the detected result.
49 * @param config System configuration.
50 * @param allocator Memory allocator (or kNULL for default).
51 * @return Operation status.
52 */
53 GoWebScanFx(kStatus) GoWebScanWebTask_Construct(GoWebScanWebTask* task, GoWebScanProcess process, GoWebScanConfig config, kAlloc allocator);
54 
55 /**
56 * Sets the handler for receiving emitted web tiles.
57 *
58 * @public @memberof GoWebScanWebTask
59 * @param task GoWebScanWebTask object.
60 * @param send Callback function
61 * @param context Receiver argument for callback.
62 * @return Operation status.
63 */
64 GoWebScanFx(kStatus) GoWebScanWebTask_SetReceiver(GoWebScanWebTask task, GoWebScanPipeSendFx send, kPointer context);
65 
66 /**
67 * Adds a message to the processing queue. Dequeues a message at the end of the queue to submit
68 * to the pipe for scheduling if no other job is currently pending.
69 *
70 * @public @memberof GoWebScanWebTask
71 * @param task GoWebScanWebTask object.
72 * @param msg Message to enqueue.
73 * @return Operation status.
74 */
75 GoWebScanFx(kStatus) GoWebScanWebTask_Send(GoWebScanWebTask task, GoWebScanPipeMsg msg);
76 
77 /**
78 * Clears the tile combiner algorithm and resets internal variables.
79 *
80 * @public @memberof GoWebScanWebTask
81 * @param task GoWebScanWebTask object.
82 * @return Operation status.
83 */
84 GoWebScanFx(kStatus) GoWebScanWebTask_Clear(GoWebScanWebTask task);
85 
86 kEndHeader()
87 #include <GoWebScanSdk/GoWebScanWebTask.x.h>
88 
89 #endif
Declares the GoWebScanPipeTask class.
Represents a task for processing raw sensor data to produce system web tiles (Web mode) or detected o...
kStatus GoWebScanWebTask_SetReceiver(GoWebScanWebTask task, GoWebScanPipeSendFx send, kPointer context)
Sets the handler for receiving emitted web tiles.
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
kStatus GoWebScanWebTask_Send(GoWebScanWebTask task, GoWebScanPipeMsg msg)
Adds a message to the processing queue.
Essential GoWebScan declarations.
Represents a task for combining outputs from multiple Merge Tasks into a single GoWebScanSystemMsg ob...
kStatus GoWebScanWebTask_Clear(GoWebScanWebTask task)
Clears the tile combiner algorithm and resets internal variables.
kStatus GoWebScanWebTask_Construct(GoWebScanWebTask *task, GoWebScanProcess process, GoWebScanConfig config, kAlloc allocator)
Constructs a GoWebScanWebTask object.
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.