GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanProcess Class Reference

Description

Represents a task for processing raw sensor data to produce system web tiles (Web mode) or detected objects (Detection mode). The GoWebScanProcess class accepts configuration via a GoWebScanConfig instance, and provides a simple API to initialize the processor, pass sensor data to the processor, retrieve completed system messages, and clear the processor. Internally, the processor delegates processing responsibilities to the Task classes in the Control group. A GoWebScanProcess object can optionally run processing tasks concurrently. Tasks are run when they receive messages, and messages are passed from task to task as processing steps execute. Task execution and message exchange are supported by the classes in the Pipe group.

A GoWebScanProcess object has a GoWebScanPipe object, and each GoWebScanProcess Task object (e.g. GoWebScanProfileSampleTask) has an associated GoWebScanPipeTask. Individual processor tasks are passed references to downstream tasks (receivers) at initialization time (e.g a GoWebScanProfileSampleTask has a reference to the GoWebScanSyncTask to which it sends messages).

Following initialization, the user application should pass inbound sensor messages to the GoWebScanProcess. The GoWebScanProcess handles the initial dispatch to various data sampling tasks. From there, messages flow from task to task, eventually resulting in outbound messages sent back to the GoWebScanProcess. Outbound messages are queued by the GoWebScanProcess object and can be accepted by the user application at any time.

Inheritance diagram for GoWebScanProcess:
Inheritance graph

Public Member Functions

kStatus GoWebScanProcess_Clear (GoWebScanProcess process)
 Aborts all outstanding processing and resets the state. More...
 
kStatus GoWebScanProcess_Construct (GoWebScanProcess *process, GoWebScanConfig config, kAlloc allocator)
 Constructs a GoWebScanProcess object. More...
 
kSSize GoWebScanProcess_ErrorCount (GoWebScanProcess process)
 Gets the current count of errors in the processor. More...
 
kStatus GoWebScanProcess_Process (GoWebScanProcess process, GoDataSet dataSet)
 Accepts inbound sensor messages and dispatches these messages to data processing tasks. More...
 
kStatus GoWebScanProcess_Receive (GoWebScanProcess process, GoWebScanPipeMsg *msg, k64s timeout)
 Returns outbound processed results if any are available. More...
 
kStatus GoWebScanProcess_Start (GoWebScanProcess process)
 Initializes the processing tasks. More...
 

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