Common protocol for all processing classes. More...
#import <LynkeosProcessing.h>
Instance Methods | |
| (id< LynkeosProcessing >) | - initWithDocument:parameters:precision: |
| Initializes the process instance with its document. More... | |
| (void) | - processItem: |
| Apply the processing to an item. More... | |
| (void) | - finishProcessing |
| There will be no more items to process. More... | |
Class Methods | |
| (ParallelOptimization_t) | + supportParallelization |
| Wether this processing class can be executed in parallel threads. More... | |
Detailed Description
Common protocol for all processing classes.
The class will be instantiated in a thread by a processing controller, which will pass it the items to process.
The processing parameters are placed in processing parameters by the associated graphical interface.
The processing results can be placed in parameters or in the "image" attribute of the processed item.
Method Documentation
| - (void) finishProcessing |
There will be no more items to process.
This method can update the document with any cumulated results.
Referenced by MyWaveletView::selectChange:.
| - (id <LynkeosProcessing>) initWithDocument: | (id< LynkeosDocument >) | document | |
| parameters: | (id< NSObject >) | params | |
| precision: | (floating_precision_t) | precision | |
Initializes the process instance with its document.
This method provides access to a proxy of the document which is meant to call exclusively the methods of the LynkeosDocument protocol (as implied by the typing). If another document method needs to be accessed, as a "processable item" for example, its reference shall be provided by the process enumerator (ie: it shall be an item).
- Parameters
-
document The document which data is being processed. params Optional parameters for the process precision The precision in which Lynkeos is running (needed for plugin processes, wich are not compiled in the main application).
- Returns
- The new processing class
| - (void) processItem: | (id< LynkeosProcessableItem >) | item |
Apply the processing to an item.
- Parameters
-
item The item to process.
Referenced by MyChromaticAlignerView::automaticOffsets:, and MyWaveletView::selectChange:.
| + (ParallelOptimization_t) supportParallelization |
Wether this processing class can be executed in parallel threads.
- Returns
- Parallelization kind
The documentation for this protocol was generated from the following file:
