Lynkeos
Public Types | Instance Methods | List of all members
<LynkeosDocument> Protocol Reference

This protocol gathers the methods provided to the processing classes by the document. More...

#import <LynkeosProcessing.h>

Inheritance diagram for <LynkeosDocument>:
Inheritance graph
[legend]
Collaboration diagram for <LynkeosDocument>:
Collaboration graph
[legend]

Public Types

enum  ParallelOptimization_t { NoParallelOptimization = 0, FFTW3ThreadsOptimization = 1, ListThreadsOptimizations = 2 }
 Kinds of multiprocessor optimisation. More...
 

Instance Methods

(void) - startProcess:withEnumerator:parameters:
 Start a list processing in several threads. More...
 
(void) - startProcess:forItem:parameters:
 Start the processing of an single item, in a separate thread. More...
 
(void) - stopProcess
 Stop the current processing. More...
 
(oneway void) - itemWasProcessed:
 Signals that an item was used in the process. More...
 
- Instance Methods inherited from <LynkeosProcessable>
(id< LynkeosProcessingParameter >) - getProcessingParameterWithRef:forProcessing:
 Returns the required processing parameter. More...
 
(id< LynkeosProcessingParameter >) - getProcessingParameterWithRef:forProcessing:goUp:
 Returns the required processing parameter. More...
 
(void) - setProcessingParameter:withRef:forProcessing:
 Updates the required processing parameter. More...
 

Detailed Description

This protocol gathers the methods provided to the processing classes by the document.

The document provides the following notifications : LynkeosProcessStartedNotification, LynkeosProcessEndedNotification, LynkeosProcessStackEndedNotification, LynkeosItemChangedNotification, LynkeosItemWasProcessedNotification, LynkeosItemAddedNotification, LynkeosItemRemovedNotification, LynkeosListChangeNotification, LynkeosDataModeChangeNotification.

Member Enumeration Documentation

Kinds of multiprocessor optimisation.

The optims can be combined with an "or".

Enumerator
NoParallelOptimization 

No optimisation at all.

FFTW3ThreadsOptimization 

Use FFTW3 threading.

ListThreadsOptimizations 

Use list processing threading.

Method Documentation

- (oneway void) itemWasProcessed: (id< LynkeosProcessableItem >)  item

Signals that an item was used in the process.

This method shall not be called by processes which modify the items ; as it causes an "item changed" notification, this method is at least useless in this case, maybe even harmful.

Parameters
itemThe item which was processed
- (void) startProcess: (Class)  processingClass
forItem: (LynkeosProcessableImage *)  item
parameters: (LynkeosImageProcessingParameter *)  params 

Start the processing of an single item, in a separate thread.

Parameters
processingClassThe class of the processing object
itemThe item to process
paramsThe processing parameters
- (void) startProcess: (Class)  processingClass
withEnumerator: (NSEnumerator *)  enumerator
parameters: (id< NSObject >)  params 

Start a list processing in several threads.

Parameters
processingClassThe class of the processing objects.
enumeratorAn enumerator of the items to process (ie: of ONLY the items to process).
paramsVolatile parameters needed by the process

Referenced by MyImageStackerView::stackAction:.

- (void) stopProcess

Stop the current processing.

Returns
None

Referenced by MyImageStackerView::stackAction:.


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