common.logic

Class LoopUnit

java.lang.Object

org.trianacode.taskgraph.Unit

common.logic.LoopUnit

public class LoopUnit
extends Unit

Loop provides the user with a facility to create loops within the network

Field Summary

Fields inherited from class org.trianacode.taskgraph.Unit

CLONE_ALL_OUTPUT, CLONE_MULTIPLE_OUTPUT, COPY_OUTPUT, ESSENTIAL, ESSENTIAL_IF_CONNECTED, IMMEDIATE_UPDATE, INTERNAL, LATE_INITIALIZE, NO_UPDATE, ON_TASK_INSTANTATION, ON_USER_ACCESS, OPTIONAL, PROCESS_UPDATE, TRANSIENT, TRANSIENT_ACCESSIBLE, USER_ACCESSIBLE

Constructor Summary

Constructors

Constructor and Description
LoopUnit()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getHelpFile()
java.lang.String[]	getInputTypes() This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g.
java.lang.String[]	getLoopTaskParams()
java.lang.String[]	getLoopTaskParams(Task ti)
java.lang.String[]	getOutputTypes() This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g.
java.lang.String	getPopUpDescription() Convienience method for retrieving the default pop-up description for this unit.
void	init() This function is called when the unit is first created.
boolean	loopCompleted()
void	parameterUpdate(java.lang.String name, java.lang.String value) Used to set each of Loop parameters.
void	process() The main unit algorithm.
void	reset() Reset Loop
void	updateParameterValue()

Methods inherited from class org.trianacode.taskgraph.Unit

debug, debug, defineParameter, dispose, extractClipInState, getClipIn, getClipIn, getControlInterface, getDefaultInputNodes, getDefaultNodeRequirement, getDefaultOutputNodes, getDisplayName, getDisplayPackage, getGUIBuilderV2Info, getHelpFileLocation, getInputAtNode, getInputNodeCount, getMaximumInputNodes, getMaximumOutputNodes, getMinimumInputNodes, getMinimumOutputNodes, getNodeInputTypes, getNodeOutputTypes, getOutputNodeCount, getOutputPolicy, getPackageName, getParameter, getParameterPanelClass, getParameterPanelInstantiate, getParameterType, getParameterUpdatePolicy, getRunnableInterface, getTask, getTaskGraphContext, getToolName, getToolPackage, getToolTable, getVersion, hideParameterPanel, isClipInName, isInputAtNode, isOutputSent, isParameter, log, log, notifyError, notifyError, output, outputAtNode, outputAtNode, parameterUpdate, parameterUpdated, putClipIn, removeClipIn, removeParameter, restoreClipInState, setDefaultInputNodes, setDefaultNodeRequirement, setDefaultOutputNodes, setDisplayName, setDisplayPackage, setGUIBuilderV2Info, setHelpFileLocation, setMaximumInputNodes, setMaximumOutputNodes, setMinimumInputNodes, setMinimumOutputNodes, setOutputPolicy, setParameter, setParameterPanelClass, setParameterPanelInstantiate, setParameterUpdatePolicy, setPopUpDescription, setRunnableInterface, setToolName, setToolPackage, setVersion, showParameterPanel, stopping

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoopUnit

public LoopUnit()

Method Detail

process

public void process()
             throws java.lang.Exception

Description copied from class: Unit

The main unit algorithm. This method should be implemented with the appropriate algorihtm for the unit (if no algorithm is implemented deadlock occurs).

Specified by:

process in class Unit

Throws:

java.lang.Exception

loopCompleted

public boolean loopCompleted()

updateParameterValue

public void updateParameterValue()

init

public void init()

Description copied from class: Unit

This function is called when the unit is first created. It should be over-ridden to initialise the tool properties (e.g. default number of nodes) and tool parameters.

Overrides:

init in class Unit

reset

public void reset()

Reset Loop

Overrides:

reset in class Unit

parameterUpdate

public void parameterUpdate(java.lang.String name,
                   java.lang.String value)

Used to set each of Loop parameters.

getPopUpDescription

public java.lang.String getPopUpDescription()

Description copied from class: Unit

Convienience method for retrieving the default pop-up description for this unit.

Overrides:

getPopUpDescription in class Unit

getHelpFile

public java.lang.String getHelpFile()

Returns:

the location of the help file for this unit.

getLoopTaskParams

public java.lang.String[] getLoopTaskParams()

Returns:

the parameters of the tasks contained within the loop

getLoopTaskParams

public java.lang.String[] getLoopTaskParams(Task ti)

Returns:

the parameters of the tasks contained within the loop

getInputTypes

public java.lang.String[] getInputTypes()

Description copied from class: Unit

This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g. triana.types.VectorType). If no package is specified then triana.types is assumed.

Specified by:

getInputTypes in class Unit

Returns:

an array of the input types for this unit

getOutputTypes

public java.lang.String[] getOutputTypes()

Description copied from class: Unit

This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g. triana.types.VectorType). If no package is specified then triana.types is assumed.

Specified by:

getOutputTypes in class Unit

Returns:

a string containing the names of the types output from Compare, each separated by a white space.