at.mug.iqm.api.processing

Interface IExecutionProtocol

All Known Implementing Classes:

ExecutionProxy

public interface IExecutionProtocol

This interface declares methods for an execution process of a single IOperator in IQM.

Author:

Philipp Kainz

Method Summary

Modifier and Type	Method and Description
void	disableInputs(AbstractOperatorGUI window) Disables the user input on a given window, i.e.
void	enableInputs(AbstractOperatorGUI window) Enables the user input on a given window, i.e.
void	executeParallelProcessing(int nThreads) Executes the processing of all selected manager items in a parallel manner.
void	executePreview(IWorkPackage wp, IOperatorGUI opGUI) Executes a preview with the given work package and GUI.
void	executeSerialProcessing() Executes the serial processing of all selected manager items.
void	finishProtocol() Finishes the protocol for an operator execution.
MultiResultDialog	getMultiResultDialog() Gets the Dialog for selecting multiple output results in order to add them to the Tank list.
IOperatorDescriptor	getOperatorDescriptor() Gets the operator descriptor of this protocol.
IOperatorGUI	getOperatorGUI() Gets the GUI of this protocol.
String	getOperatorName() Gets the name of the currently launched operator.
Result	getPreviewResult() Gets the preview result in the current execution protocol.
IWorkPackage	getWorkPackage() Gets the work package of this protocol.
int	launchProtocol() Launches the protocol and initiates the GUI building.
void	setPreviewResult(IResult previewResult) Sets the preview result in the current execution protocol.
void	setVirtualFlagToOperatorGUI(boolean virtual) Sets the "virtual" flag to the operator's GUI, if supported.
void	updateGUI() Updates the GUI, if a change in the sources occurs, e.g.
int[]	updateSources(int[] currMgrIdxs, int[] targetMgrIdxs) This method tries to update the manager indices for the processing with the launched operator.

Method Detail

executePreview

void executePreview(IWorkPackage wp,
                    IOperatorGUI opGUI)

Executes a preview with the given work package and GUI.

Parameters:

wp -

opGUI -

finishProtocol

void finishProtocol()

Finishes the protocol for an operator execution. New operators may be launched thereafter.

updateGUI

void updateGUI()
        throws Exception

Updates the GUI, if a change in the sources occurs, e.g. if RGB images are loaded and the GUI has to adapt.

Throws:

Exception - , if this adaption fails

updateSources

int[] updateSources(int[] currMgrIdxs,
                    int[] targetMgrIdxs)

This method tries to update the manager indices for the processing with the launched operator.

Parameters:

currMgrIdxs - the current manager indices

targetMgrIdxs - the target manager indices

Returns:

either the current indices, if updating fails, or the target indices, if it succeeds

getOperatorName

String getOperatorName()

Gets the name of the currently launched operator.

Returns:

the unique operator name specified in the String[][] resources with the key GlobalName

getWorkPackage

IWorkPackage getWorkPackage()

Gets the work package of this protocol.

Returns:

the work package

getOperatorGUI

IOperatorGUI getOperatorGUI()

Gets the GUI of this protocol.

Returns:

the GUI

getOperatorDescriptor

IOperatorDescriptor getOperatorDescriptor()

Gets the operator descriptor of this protocol.

Returns:

the operator descriptor.

enableInputs

void enableInputs(AbstractOperatorGUI window)

Enables the user input on a given window, i.e. an operator's GUI. Furthermore, this method displays a wait cursor on the window.

Parameters:

window - the window to disable the input on

disableInputs

void disableInputs(AbstractOperatorGUI window)

Disables the user input on a given window, i.e. an operator's GUI. Furthermore, this method hides the wait cursor and switches back to default cursor.

Parameters:

window - the window to disable the input on

executeSerialProcessing

void executeSerialProcessing()

Executes the serial processing of all selected manager items. Every item will be processed with the same operator and parameters.

executeParallelProcessing

void executeParallelProcessing(int nThreads)

Executes the processing of all selected manager items in a parallel manner. Every item will be processed with the same operator and parameters, but each item is processed in a separate thread. The number of threads is specified by nThreads.

Parameters:

nThreads - the number of threads that are supposed to run concurrently

setVirtualFlagToOperatorGUI

void setVirtualFlagToOperatorGUI(boolean virtual)

Sets the "virtual" flag to the operator's GUI, if supported.

Parameters:

virtual - true, if the check box should be selected, false otherwise

launchProtocol

int launchProtocol()

Launches the protocol and initiates the GUI building.

Returns:

the ExecutionState after launching

getMultiResultDialog

MultiResultDialog getMultiResultDialog()

Gets the Dialog for selecting multiple output results in order to add them to the Tank list.

Returns:

a reference to the MultiResultDialog

setPreviewResult

void setPreviewResult(IResult previewResult)

Sets the preview result in the current execution protocol.

Parameters:

previewResult -

getPreviewResult

Result getPreviewResult()

Gets the preview result in the current execution protocol.

Returns:

the preview result instance