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.
Public Member Functions | |
| kStatus | GoWebScanProcess_Clear (GoWebScanProcess process) |
| Aborts all outstanding processing and resets the state. More... | |
| kStatus | GoWebScanProcess_ClearRecording (GoWebScanProcess process) |
| Clear the recorded GoDataSet objects. More... | |
| kStatus | GoWebScanProcess_Construct (GoWebScanProcess *process, GoWebScanConfig config, kAlloc allocator) |
| Constructs a GoWebScanProcess object. More... | |
| const GoDataSet * | GoWebScanProcess_DataSetAt (GoWebScanProcess process, kSize index) |
| Access a recorded GoDataSet object by index. More... | |
| kSize | GoWebScanProcess_DataSetCount (GoWebScanProcess process) |
| Return the number of GoDataSet objects that have been recorded. More... | |
| kStatus | GoWebScanProcess_EnableRecording (GoWebScanProcess process, kBool recordingEnabled) |
| Enable or disable recording. More... | |
| kSSize | GoWebScanProcess_ErrorCount (GoWebScanProcess process) |
| Gets the current count of errors in the processor. More... | |
| kSize | GoWebScanProcess_MaxRecordBoardCount (GoWebScanProcess process) |
| Return the max number of boards that may result from the recorded GoDataSet objects. More... | |
| k64u | GoWebScanProcess_MaxRecordSize (GoWebScanProcess process) |
| Return the max allowed size in bytes of the recorded GoDataSet objects. More... | |
| kStatus | GoWebScanProcess_Process (GoWebScanProcess process, GoDataSet dataSet) |
| Accepts inbound sensor message sets and dispatches the messages to data processing tasks. More... | |
| GoWebScanProcessRecordStatus | GoWebScanProcess_ProcessRecordStatus (GoWebScanProcess process) |
| Return the status of the GoDataSet object recording functionality. More... | |
| kStatus | GoWebScanProcess_Receive (GoWebScanProcess process, GoWebScanPipeMsg *msg, k64s timeout) |
| Returns outbound processed results if any are available. More... | |
| kSize | GoWebScanProcess_RecordBoardCount (GoWebScanProcess process) |
| Return the number of boards processed from GoDataSet objects that were recorded. More... | |
| GoWebScanRecording | GoWebScanProcess_Recording (GoWebScanProcess process) |
| Get the recording of processed sensor message sets. More... | |
| kBool | GoWebScanProcess_RecordingEnabled (GoWebScanProcess process) |
| Return whether or not recording is enabled. More... | |
| k64u | GoWebScanProcess_RecordSize (GoWebScanProcess process) |
| Return the approximate total size in bytes of the recorded GoDataSet objects. More... | |
| kStatus | GoWebScanProcess_Refresh (GoWebScanProcess process) |
| Refresh the process. More... | |
| kStatus | GoWebScanProcess_SaveRecording (GoWebScanProcess process, const kChar *filePath) |
| Save a file containing the recorded GoDataSet objects to the specified file path. More... | |
| kStatus | GoWebScanProcess_SetDataHandler (GoWebScanProcess process, GoDataFx function, kPointer receiver) |
| Sets a callback function that can be used to receive output board data asynchronously. More... | |
| kStatus | GoWebScanProcess_SetLaneDisabledHandler (GoWebScanProcess process, GoWebScanTileCombinerLaneChangeFx function, kPointer receiver) |
| Set handler for when sync task disables a camera lane. More... | |
| kStatus | GoWebScanProcess_SetLaneEnabledHandler (GoWebScanProcess process, GoWebScanTileCombinerLaneChangeFx function, kPointer receiver) |
| Set handler for when sync task re-enables a camera lane. More... | |
| kStatus | GoWebScanProcess_SetMaxRecordBoardCount (GoWebScanProcess process, kSize maxRecordBoardCount) |
| Set the max number of boards that may result from the recorded GoDataSet objects. More... | |
| kStatus | GoWebScanProcess_SetMaxRecordSize (GoWebScanProcess process, k64u maxRecordSize) |
| Set the max allowed size in bytes of the recorded GoDataSet objects. More... | |
| kStatus | GoWebScanProcess_Start (GoWebScanProcess process) |
| Initializes the processing tasks. More... | |
The documentation for this class was generated from the following file: