< LynkeosProcessing > Protocol Reference
[Processing classes]

Common protocol for all processing classes. More...

#import <LynkeosProcessing.h>

Inheritance diagram for < LynkeosProcessing >:

[legend]

Collaboration diagram for < LynkeosProcessing >:

[legend]

List of all members.

Public Member Functions
(id< LynkeosProcessing >)	- initWithDocument:parameters:precision:
	Initializes the process instance with its document.
(void)	- processItemWithSinglePrecision:
	Apply the processing to an item containing single precision data.
(void)	- processItemWithDoublePrecision:
	Apply the processing to an item containing double precision data.
(void)	- finishProcessing
	There will be no more items to process.
Static Public Member Functions
(BOOL)	+ supportParallelization
	Wether this processing class can be executed in parallel threads.

---

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.

---

Member Function Documentation

+ (BOOL) supportParallelization

Wether this processing class can be executed in parallel threads.

Returns:

Parallelization authorization

- (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).

- (void) processItemWithSinglePrecision:

(id< LynkeosProcessableItem >)

item

Apply the processing to an item containing single precision data.

Parameters:

item

The item to process. There is one method per precision to avoid a precision test at each item processing.

- (void) processItemWithDoublePrecision:

(id< LynkeosProcessableItem >)

item

Apply the processing to an item containing double precision data.

Parameters:

item

The item to process.

- (void) finishProcessing

There will be no more items to process.

Returns:

None This method can update the document with any cumulated results.

---

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

• LynkeosProcessing.h

---