Lynkeos
Instance Methods | List of all members
<LynkeosProcessable> Protocol Reference

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]

Instance Methods

(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 is implemented by the classes which store and provide parameters.

Method Documentation

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

Returns the required processing 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.

Parameters
refA string identifying this parameter in its class.
processingA string identifying the owner of this parameter. nil is valid, if the parameter is of general scope.
Returns
The required parameter

Referenced by MyImageAnalyzerView::autoSelectAction:.

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

Returns the required processing parameter.

Parameters
refA string identifying this parameter in its class.
processingA string identifying the owner of this parameter. nil is valid, if the parameter is of general scope.
goUpWhether 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
parameterThe new parameter value
refA string identifying this parameter in its class.
processingA string identifying the owner of this parameter. nil is valid, if the parameter is of general scope.
Returns
The required parameter

Referenced by MyChromaticAlignerView::automaticOffsets:, MyChromaticAlignerView::changeOffset:, and ProcessStackManager::getParameterForItem:andParam:.


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