< LynkeosProcessable > Protocol Reference
[Processing classes]

This protocol is implemented by the classes which store and provide parameters. More...

#import <LynkeosProcessing.h>

Inheritance diagram for < LynkeosProcessable >:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

(id< LynkeosProcessingParameter >) - getProcessingParameterWithRef:forProcessing:
 Returns the required processing parameter.
(id< LynkeosProcessingParameter >) - getProcessingParameterWithRef:forProcessing:goUp:
 Returns the required processing parameter.
(void) - setProcessingParameter:withRef:forProcessing:
 Updates the required processing parameter.


Detailed Description

This protocol is implemented by the classes which store and provide parameters.

Member Function Documentation

- (id <LynkeosProcessingParameter>) getProcessingParameterWithRef: (NSString *)  ref
forProcessing: (NSString *)  processing 

Returns the required processing parameter.

Parameters:
ref A string identifying this parameter in its class.
processing A string identifying the owner of this parameter. nil is valid, if the parameter is of general scope.
Returns:
The required parameter The expected behavior is that items being stored in hierachical trees, if the item cannot be found in an item, the item itself tries to retrieve it from its container item.

- (id <LynkeosProcessingParameter>) getProcessingParameterWithRef: (NSString *)  ref
forProcessing: (NSString *)  processing
goUp: (BOOL)  goUp 

Returns the required processing parameter.

Parameters:
ref A string identifying this parameter in its class.
processing A string identifying the owner of this parameter. nil is valid, if the parameter is of general scope.
goUp Whether to look for the parameter up in the hierarchy
Returns:
The required parameter

- (void) setProcessingParameter: (id< LynkeosProcessingParameter >)  parameter
withRef: (NSString *)  ref
forProcessing: (NSString *)  processing 

Updates the required processing parameter.

Parameters:
parameter The new parameter value
ref A string identifying this parameter in its class.
processing A string identifying the owner of this parameter. nil is valid, if the parameter is of general scope.
Returns:
The required parameter


The documentation for this protocol was generated from the following file:
Generated on Sat Mar 22 17:44:50 2008 for Lynkeos by  doxygen 1.5.4