org.trianacode.taskgraph

Class Unit

java.lang.Object

org.trianacode.taskgraph.Unit

Direct Known Subclasses:

AbstractTaskHolder, AccumStat, AccumStat, AcquisitionTime, Adder, ALE, AllPass, AllPassFilter, AmplitudeSpectrum, AmpSpect, AnnotatedUnitWrapper, ArcCos, ArcCosh, ArcSin, ArcSinh, ArcTan, ArcTanh, ArrayLength, ArrayToStream, ArrayViewer, ATanCont, Atmosphere, AudioToGSM, AutoCorel, AutoPad, BandPass, BandPass, BeanUnit, Binary, BinaryImporter, Block, Brightness, Buffer, CannonTrajectory, Chirp, ColIntegrate, ColorGen, ColumnMax, CombDelay, CombFilter, Compare, Compatible, Complexify, Compressor, Concat, ConcatTime, Condor, CondorSubmitDescription, Conjugate, Conjugate, ConstBuffer, ConstGen, ConstToDouble, ConstView, Convolve, Correlate, Cosh, Cosine, Count, CountBlobs, CrossCorel, CSpecToVect, CSSetToVect, CSVtoVect, CurveToVect, DBExplore, Decimate, DeSerialize, Distance, Divider, DoubleGen, DoubleToComplex, DoubleToConst, DoubleView, Duplicator, EarthOrbit, EdgeDetect, EmptyStringCreator, EnhContrast, EventGen, EventViewer, Exp, Expander, Export, Fader, FFT, FFTW, Filter, FIR_BandPass, FIR_Filter, FIR_HighPass, FIR_LowPass, FitLine, ForNext, FreqBPF, FreqHist, FreqHPF, FrequencyResolution, FullSpectrum, FuzzBox, Gain, Gaussian, GenerateCurve, GenGaussian, GenRandNoise, GetBlue, GetGreen, GetHoles, GetRed, GnuplotGrapher, GraceGrapher, GradientEdge, GSMToAudio, HalfSampleRate, HetdyneF, Heterodyne, HighFreq, HighPass, HighPass, HighPass50, Histogrammer, HistoryWriter, HistToVect, HTMLViewer, ID3Xtractor, If, IfElse, IIR_Filter, ImageAdd, ImageAnd, ImageBlur, ImageDiff, ImageMapper, ImageMapper, ImageOr, ImageReader, ImageView, ImageXor, ImagPart, Import2Col, ImportGSM, Incrementer, InOut, InputString, IntScroller, Invert, InvertWave, Is, JPlotter, Kurtosis, Length, LineIn, Ln, Lnb, LoadMovie, LoadMP3, LoadSound, LoadSoundNoGUI, Log10, Loop, LoopUnit, LowFreq, LowPass, LowPass, LowPassAv, LPAverage, LPF, Magnitude, MakeControlTool, MakeCurve, MakeFileReader, MakeFileWriter, MakeMatrix, MatchFilter, MathCalc, MatrixToDoubleArray, MatrixToVect, MAudioToSSet, Maximum, Median, MercPert, Merge, Minimum, Mono2Stereo, MultiBand, Multiple, Multiplier, MusicCrawler, Name, Negate, NegativeF, Neutron, NewInstance, NewtonianChirp, NodeMixer, Normalise, Normaliser, NotchFilter, NoteMapper, OldUnit, OneSide, OneSide, Orbit, PackData, Pad, ParamNameChange, ParamView, Pause, PeakEQ, Phase, PhaseCont, PitchDet, PitchDetection, Planck, Play, PositiveF, Power, PowerSpectrum, PowInteger, PwrSpect, RandNoise, Random, Random, RealPart, Recip, Rectifier, Reflect, RelativisticOrbit, ReplaceAll, ReplaceData, ReplaceFirst, ReSequence, Reverse, RotateLeft, RotateRight, RowIntegrate, RowMax, RuntimeTaskCreation, SampleRate, SampleSetBuffer, ScaleImage, Scaler, ScalerText, Scroller, Sequence, SequenceBuffer, Serialize, SetAcqTime, SetBlue, SetGreen, SetLabels, SetName, SetRed, SGTGrapher, SGTTimeFreq, Shift, ShrinkWhite, SigThresh, Sine, SingleDelay, Sinh, Skewness, Snb, SpecAver, SpecSeq, SpecSeq, SpectToVect, SphereGravity, Split, Split, SqMag, Sqrt, Square, SSetToMAudio, SSetToVect, Star, Stereo2Mono, Stopper, StreamToArray, Stretch, StringEditor, StringGen, StringIn, StringToConst, StringViewer, Subtracter, Subvector, Sum, SumElements, SumOfSquares, SwapLWithR, SystemOut, TableImporter, Tangent, Tanh, Test, Tester, TestNarrow, TestTwoSided, Threshold, TimerOn, TimerWriter, ToClass, ToGreyScale, Trend, TriggerAt, TriggerButton, TriggerCrontab, TriggerDelay, TriggerRounds, TrueFalseGen, TypeExport, TypeImport, URLImage, VariableDelay, VariableDummyUnit, VariableDynamics, Variance, VectToConst, VectToCSpec, VectToCSSet, VectToDouble, VectToDoubleArray, VectToMatrix, VectToSpec, VectToSSet, ViewPoint, Wave, WaveView, WindowFnc, WinFT, WriteAiff_old, WriteGIF, WriteGSM, XMax, XMin, XValues, ZeroMean

public abstract class Unit
extends java.lang.Object

Class Description Here...

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLONE_ALL_OUTPUT
static java.lang.String	CLONE_MULTIPLE_OUTPUT
static java.lang.String	COPY_OUTPUT Output polices
static java.lang.String	ESSENTIAL Node requirements
static java.lang.String	ESSENTIAL_IF_CONNECTED
static java.lang.String	IMMEDIATE_UPDATE Parameter update polices
static java.lang.String	INTERNAL Parameter types
static java.lang.String	LATE_INITIALIZE
static java.lang.String	NO_UPDATE
static java.lang.String	ON_TASK_INSTANTATION
static java.lang.String	ON_USER_ACCESS Parameter panel instatiation options
static java.lang.String	OPTIONAL
static java.lang.String	PROCESS_UPDATE
static java.lang.String	TRANSIENT
static java.lang.String	TRANSIENT_ACCESSIBLE
static java.lang.String	USER_ACCESSIBLE

Constructor Summary

Constructors

Constructor and Description
Unit()
Unit(java.lang.String name, java.lang.String pkge)

Method Summary

Methods

Modifier and Type	Method and Description
void	debug(java.lang.String msg)
void	debug(java.lang.String msg, java.lang.Throwable t)
void	defineParameter(java.lang.String paramname, java.lang.Object initvalue, java.lang.String type) Defines the initial value and type of a parameter.
void	dispose() This function is called when the unit is deleted.
ClipInStore	extractClipInState()
java.lang.Object	getClipIn(java.lang.Object data, java.lang.String name)
java.lang.Object	getClipIn(java.lang.String name)
ControlInterface	getControlInterface() Use to access functions within the Control Interface.
int	getDefaultInputNodes() Convienience method for retrieving default number of output nodes for this unit.
java.lang.String	getDefaultNodeRequirement()
int	getDefaultOutputNodes() Convienience method for retrieving default number of output nodes for this unit.
java.lang.String	getDisplayName()
java.lang.String	getDisplayPackage()
java.lang.String	getGUIBuilderV2Info() Convienience method that returns the information used to create a GUI with GUI Builder V2
java.lang.String	getHelpFileLocation() Convienience method for retrieving default help file location for this unit.
java.lang.Object	getInputAtNode(int nodeNumber) Returns the data at input node nodeNumber.
int	getInputNodeCount()
abstract java.lang.String[]	getInputTypes() This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g.
int	getMaximumInputNodes() Convienience method for retrieving maximum number of input nodes for this unit.
int	getMaximumOutputNodes() Convienience method for retrieving maximum number of output nodes for this unit.
int	getMinimumInputNodes() Convienience method for retrieving minimum number of input nodes for this unit.
int	getMinimumOutputNodes() Convienience method for retrieving minimum number of output nodes for this unit.
java.lang.String[][]	getNodeInputTypes() This method should return an array of the data types accepted by specific nodes, with the node index providing the index for the array.
java.lang.String[][]	getNodeOutputTypes() This method should return an array of the data types output by specific nodes, with the node index providing the index for the array.
int	getOutputNodeCount()
java.lang.String	getOutputPolicy() Covienience method that returns the output policy for this unit.
abstract java.lang.String[]	getOutputTypes() This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g.
protected java.lang.String	getPackageName(java.lang.String fullname)
java.lang.Object	getParameter(java.lang.String paramname)
java.lang.String	getParameterPanelClass() Covienience method that returns the custom parameter panel class used
java.lang.String	getParameterPanelInstantiate() Covienience method that returns the custom parameter panel class used
java.lang.Object	getParameterType(java.lang.String paramname)
java.lang.String	getParameterUpdatePolicy() Covienience method that returns the parameter update policy for this unit.
java.lang.String	getPopUpDescription() Convienience method for retrieving the default pop-up description for this unit.
protected RunnableInterface	getRunnableInterface() Use to access functions within RunnableTask
Task	getTask() Use to access functions within the Task Interface
TaskGraphContext	getTaskGraphContext()
java.lang.String	getToolName()
java.lang.String	getToolPackage()
ToolTable	getToolTable()
java.lang.String	getVersion()
void	hideParameterPanel()
void	init() This function is called when the unit is first created.
boolean	isClipInName(java.lang.String name)
boolean	isInputAtNode(int nodeNumber)
boolean	isOutputSent(int outputNode)
boolean	isParameter(java.lang.String paramname)
void	log(java.lang.String msg)
void	log(java.lang.String msg, java.lang.Throwable t)
void	notifyError(java.lang.String message)
void	notifyError(java.lang.String message, java.lang.Throwable throwable) Stops the network running
void	output(java.lang.Object data) Outputs the data across all nodes.
void	outputAtNode(int outputNode, java.lang.Object data) Outputs the data to the given node outputNode..
void	outputAtNode(int outputNode, java.lang.Object data, boolean blocking) Outputs the data to the given node outputNode.
void	parameterUpdate(java.lang.String paramname, java.lang.Object value)
void	parameterUpdated(java.lang.String paramname, java.lang.Object value)
abstract void	process() The main unit algorithm.
void	putClipIn(java.lang.String name, java.lang.Object clipin) Put the specified clip-in into this task's clip-in bucket
java.lang.Object	removeClipIn(java.lang.String name) Remove the clip-in with the specified name from this task's clip-in bucket.
void	removeParameter(java.lang.String paramname) Removes a task parameter
void	reset() This function is called when the reset is pressed on the gui.
void	restoreClipInState(ClipInStore store) Restores a previously stored clip-in bucket state
void	setDefaultInputNodes(int inodes) Convienience method for setting the default number of input nodes for this unit.
void	setDefaultNodeRequirement(java.lang.String requirement) Sets the default node requirements for this unit (ESSENTIAL, ESSENTIAL_IF_CONNECTED or OPTIONAL)
void	setDefaultOutputNodes(int onodes) Convienience method for setting the default number of output nodes for this unit.
void	setDisplayName(java.lang.String displayName)
void	setDisplayPackage(java.lang.String displayPackage)
void	setGUIBuilderV2Info(java.lang.String info) Convienience method that sets the information used to create a GUI with GUI Builder V2.
void	setHelpFileLocation(java.lang.String location) Convienience method for setting the default help file location.
void	setMaximumInputNodes(int inodes) Convienience method for setting the maximum number of input nodes for this unit.
void	setMaximumOutputNodes(int onodes) Convienience method for setting the maximum number of output nodes for this unit.
void	setMinimumInputNodes(int inodes) Convienience method for setting the minimum number of input nodes for this unit.
void	setMinimumOutputNodes(int onodes) Convienience method for setting the minimum number of output nodes for this unit.
void	setOutputPolicy(java.lang.String policy) Convienience method that sets the output policy for this unit.
void	setParameter(java.lang.String paramname, java.lang.Object value) Sets the value of a task parameter
void	setParameterPanelClass(java.lang.String classname) Convienience method that sets the custom parameter panel used.
void	setParameterPanelInstantiate(java.lang.String policy) Convienience method that sets the when the parameter panel is instantiated, either ON_USER_ACCESS or ON_TASK_INSTANTIATION.
void	setParameterUpdatePolicy(java.lang.String policy) Convienience method that sets the parameter update policy for this unit.
void	setPopUpDescription(java.lang.String location) Convienience method for setting the default pop-up description.
void	setRunnableInterface(RunnableInterface runnableTask) Set the access to a RunnableTask
void	setToolName(java.lang.String toolName)
void	setToolPackage(java.lang.String toolPackage)
void	setVersion(java.lang.String version)
void	showParameterPanel() Display the parameter panel for this unit.
void	stopping() This is called when the network is forcably stopped by the user.

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL

public static final java.lang.String INTERNAL

Parameter types

See Also:

Constant Field Values

TRANSIENT

public static final java.lang.String TRANSIENT

See Also:

Constant Field Values

LATE_INITIALIZE

public static final java.lang.String LATE_INITIALIZE

See Also:

Constant Field Values

USER_ACCESSIBLE

public static final java.lang.String USER_ACCESSIBLE

See Also:

Constant Field Values

TRANSIENT_ACCESSIBLE

public static final java.lang.String TRANSIENT_ACCESSIBLE

See Also:

Constant Field Values

IMMEDIATE_UPDATE

public static final java.lang.String IMMEDIATE_UPDATE

Parameter update polices

See Also:

Constant Field Values

PROCESS_UPDATE

public static final java.lang.String PROCESS_UPDATE

See Also:

Constant Field Values

NO_UPDATE

public static final java.lang.String NO_UPDATE

See Also:

Constant Field Values

ON_USER_ACCESS

public static final java.lang.String ON_USER_ACCESS

Parameter panel instatiation options

See Also:

Constant Field Values

ON_TASK_INSTANTATION

public static final java.lang.String ON_TASK_INSTANTATION

See Also:

Constant Field Values

COPY_OUTPUT

public static final java.lang.String COPY_OUTPUT

Output polices

See Also:

Constant Field Values

CLONE_MULTIPLE_OUTPUT

public static final java.lang.String CLONE_MULTIPLE_OUTPUT

See Also:

Constant Field Values

CLONE_ALL_OUTPUT

public static final java.lang.String CLONE_ALL_OUTPUT

See Also:

Constant Field Values

ESSENTIAL

public static final java.lang.String ESSENTIAL

Node requirements

See Also:

Constant Field Values

ESSENTIAL_IF_CONNECTED

public static final java.lang.String ESSENTIAL_IF_CONNECTED

See Also:

Constant Field Values

OPTIONAL

public static final java.lang.String OPTIONAL

See Also:

Constant Field Values

Constructor Detail

Unit

public Unit()

Unit

public Unit(java.lang.String name,
    java.lang.String pkge)

Method Detail

getPackageName

protected java.lang.String getPackageName(java.lang.String fullname)

setRunnableInterface

public void setRunnableInterface(RunnableInterface runnableTask)

Set the access to a RunnableTask

getRunnableInterface

protected RunnableInterface getRunnableInterface()

Use to access functions within RunnableTask

getTask

public Task getTask()

Use to access functions within the Task Interface

getControlInterface

public ControlInterface getControlInterface()

Use to access functions within the Control Interface.

getToolName

public java.lang.String getToolName()

Returns:

the name of this tool.

getToolPackage

public java.lang.String getToolPackage()

setToolPackage

public void setToolPackage(java.lang.String toolPackage)

setToolName

public void setToolName(java.lang.String toolName)

getDisplayName

public java.lang.String getDisplayName()

setDisplayName

public void setDisplayName(java.lang.String displayName)

getDisplayPackage

public java.lang.String getDisplayPackage()

setDisplayPackage

public void setDisplayPackage(java.lang.String displayPackage)

getNodeInputTypes

public java.lang.String[][] getNodeInputTypes()

This method should return an array of the data types accepted by specific nodes, with the node index providing the index for the array. For nodes not covered by the array, the types specified by getInputTypes() are assumed.

Returns:

an array of the input types for this unit

getInputTypes

public abstract java.lang.String[] getInputTypes()

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.

Returns:

an array of the input types for this unit

getNodeOutputTypes

public java.lang.String[][] getNodeOutputTypes()

This method should return an array of the data types output by specific nodes, with the node index providing the index for the array. For nodes not covered by the array, the types specified by getOutputTypes() are assumed.

Returns:

an array of the input types for this unit

getOutputTypes

public abstract java.lang.String[] getOutputTypes()

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.

Returns:

an array of the output types for this unit

init

public void init()

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.

reset

public void reset()

This function is called when the reset is pressed on the gui. It restore the unit to its pre-start state.

dispose

public void dispose()

This function is called when the unit is deleted. It should be over-ridden to clean up the unit (e.g. close open files).

parameterUpdate

public void parameterUpdate(java.lang.String paramname,
                   java.lang.Object value)

parameterUpdated

public final void parameterUpdated(java.lang.String paramname,
                    java.lang.Object value)

process

public abstract void process()
                      throws java.lang.Exception

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

Throws:

java.lang.Exception

stopping

public void stopping()

This is called when the network is forcably stopped by the user. This should be over-ridden with the desired tasks.

notifyError

public final void notifyError(java.lang.String message,
               java.lang.Throwable throwable)

Stops the network running

notifyError

public final void notifyError(java.lang.String message)

getParameter

public java.lang.Object getParameter(java.lang.String paramname)

Returns:

the value of a task parameter. (null if not set)

getParameterType

public java.lang.Object getParameterType(java.lang.String paramname)

Returns:

the type of a task parameter

defineParameter

public void defineParameter(java.lang.String paramname,
                   java.lang.Object initvalue,
                   java.lang.String type)

Defines the initial value and type of a parameter. If the parameter is already defined, such as when the unit is recreated from a serialized version, then nothing happens. This method should generally only be used in the init method. Note that a parameterUpdate call is not generated.

The type of the parameter can either be:

USER_ACCESSIBLE - The user is allowed to dynamically update the value INTERNAL - The parameter is hidden from the user TRANSIENT - The parameter is hidden from the user and does not get saved when the taskgraph is serialized

Parameters:

paramname - the name of the parameter

initvalue - the value of the parameter (null if not defined)

type - see above

isParameter

public boolean isParameter(java.lang.String paramname)

Returns:

true if a parameter with the specified name is set

setParameter

public void setParameter(java.lang.String paramname,
                java.lang.Object value)

Sets the value of a task parameter

removeParameter

public void removeParameter(java.lang.String paramname)

Removes a task parameter

getInputNodeCount

public int getInputNodeCount()

Returns:

the number of data input nodes.

getOutputNodeCount

public int getOutputNodeCount()

Returns:

the number of data output nodes.

isInputAtNode

public boolean isInputAtNode(int nodeNumber)

Returns:

true if there is data waiting on the specified node

getInputAtNode

public java.lang.Object getInputAtNode(int nodeNumber)

Returns the data at input node nodeNumber. If data is not ready, NOT_READY triana type is returned. If there is no cable connected to the input node the NOT_CONNECTED triana type is returned.

Parameters:

nodeNumber - the particular node you want to get the data from.

output

public void output(java.lang.Object data)

Outputs the data across all nodes. This passses the given data set to the first output node and then makes copies for any other output nodes. This method blocks until the data is successfully sent.

Parameters:

data - the data to be sent

outputAtNode

public void outputAtNode(int outputNode,
                java.lang.Object data)

Outputs the data to the given node outputNode.. This method is used to set the data at each particular output node if this is necessary, otherwise use output to copy the data across all nodes. This method blocks until the data is successfully sent.

Parameters:

outputNode - the output node you wish to set

data - the data to be sent

outputAtNode

public void outputAtNode(int outputNode,
                java.lang.Object data,
                boolean blocking)

Outputs the data to the given node outputNode. If specified this method blocks until the data is successfully sent (usual behaviour), otherwise, if non-blocking, isOutputSent() can be used to poll whether the data has been successfully sent.

Parameters:

outputNode - the output node you wish to set

data - the data to be sent

blocking - true if this method should block until the data is sent

isOutputSent

public boolean isOutputSent(int outputNode)

Returns:

true if the data sent with an output call has reached its destination

See Also:

void outputAtNode(int outputNode, Object data, boolean blocking)

getClipIn

public java.lang.Object getClipIn(java.lang.Object data,
                         java.lang.String name)

Returns:

the clip-in with the specified name that came attached to the the specified data item (null if not present). Only clip-ins for data that has been input in the current process can be retrieved.

getClipIn

public java.lang.Object getClipIn(java.lang.String name)

Returns:

the clip-in attached to this task with the specified name (null if not present)

putClipIn

public void putClipIn(java.lang.String name,
             java.lang.Object clipin)

Put the specified clip-in into this task's clip-in bucket

removeClipIn

public java.lang.Object removeClipIn(java.lang.String name)

Remove the clip-in with the specified name from this task's clip-in bucket.

Returns:

the removed clip-in (or null if unknown)

isClipInName

public boolean isClipInName(java.lang.String name)

Returns:

true if a clip-in with the specified name exists in this task's clip-in bucket

extractClipInState

public ClipInStore extractClipInState()

Returns:

a store of the state of the current clip-in bucket

restoreClipInState

public void restoreClipInState(ClipInStore store)

Restores a previously stored clip-in bucket state

getToolTable

public ToolTable getToolTable()

Returns:

the tool table

getMaximumInputNodes

public int getMaximumInputNodes()

Convienience method for retrieving maximum number of input nodes for this unit.

setMaximumInputNodes

public void setMaximumInputNodes(int inodes)

Convienience method for setting the maximum number of input nodes for this unit. This method should only be called from within the init() method.

getMinimumInputNodes

public int getMinimumInputNodes()

Convienience method for retrieving minimum number of input nodes for this unit.

setMinimumInputNodes

public void setMinimumInputNodes(int inodes)

Convienience method for setting the minimum number of input nodes for this unit. This method should only be called from within the init() method.

getDefaultInputNodes

public int getDefaultInputNodes()

Convienience method for retrieving default number of output nodes for this unit.

setDefaultInputNodes

public void setDefaultInputNodes(int inodes)

Convienience method for setting the default number of input nodes for this unit. This method should only be called from within the init() method.

getMaximumOutputNodes

public int getMaximumOutputNodes()

Convienience method for retrieving maximum number of output nodes for this unit.

setMaximumOutputNodes

public void setMaximumOutputNodes(int onodes)

Convienience method for setting the maximum number of output nodes for this unit. This method should only be called from within the init() method.

getMinimumOutputNodes

public int getMinimumOutputNodes()

Convienience method for retrieving minimum number of output nodes for this unit.

setMinimumOutputNodes

public void setMinimumOutputNodes(int onodes)

Convienience method for setting the minimum number of output nodes for this unit. This method should only be called from within the init() method.

getDefaultOutputNodes

public int getDefaultOutputNodes()

Convienience method for retrieving default number of output nodes for this unit.

setDefaultOutputNodes

public void setDefaultOutputNodes(int onodes)

Convienience method for setting the default number of output nodes for this unit. This method should only be called from within the init() method.

getPopUpDescription

public java.lang.String getPopUpDescription()

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

setPopUpDescription

public void setPopUpDescription(java.lang.String location)

Convienience method for setting the default pop-up description.

getHelpFileLocation

public java.lang.String getHelpFileLocation()

Convienience method for retrieving default help file location for this unit.

setHelpFileLocation

public void setHelpFileLocation(java.lang.String location)

Convienience method for setting the default help file location. If only a filename is specified then the toolbox location + /help is assumed. All tools should have help files, which should be written in HTML.

getParameterUpdatePolicy

public java.lang.String getParameterUpdatePolicy()

Covienience method that returns the parameter update policy for this unit.

setParameterUpdatePolicy

public void setParameterUpdatePolicy(java.lang.String policy)

Convienience method that sets the parameter update policy for this unit. This method should only be called from within the init() method.

getOutputPolicy

public java.lang.String getOutputPolicy()

Covienience method that returns the output policy for this unit.

setOutputPolicy

public void setOutputPolicy(java.lang.String policy)

Convienience method that sets the output policy for this unit. This method should only be called from within the init() method.

setGUIBuilderV2Info

public void setGUIBuilderV2Info(java.lang.String info)

Convienience method that sets the information used to create a GUI with GUI Builder V2. This method should only be called from within the init() method.

getGUIBuilderV2Info

public java.lang.String getGUIBuilderV2Info()

Convienience method that returns the information used to create a GUI with GUI Builder V2

setParameterPanelClass

public void setParameterPanelClass(java.lang.String classname)

Convienience method that sets the custom parameter panel used. This method should only be called from within the init() method.

getParameterPanelClass

public java.lang.String getParameterPanelClass()

Covienience method that returns the custom parameter panel class used

setParameterPanelInstantiate

public void setParameterPanelInstantiate(java.lang.String policy)

Convienience method that sets the when the parameter panel is instantiated, either ON_USER_ACCESS or ON_TASK_INSTANTIATION. This method should only be called from within the init() method.

getParameterPanelInstantiate

public java.lang.String getParameterPanelInstantiate()

Covienience method that returns the custom parameter panel class used

setDefaultNodeRequirement

public void setDefaultNodeRequirement(java.lang.String requirement)

Sets the default node requirements for this unit (ESSENTIAL, ESSENTIAL_IF_CONNECTED or OPTIONAL)

getDefaultNodeRequirement

public java.lang.String getDefaultNodeRequirement()

Returns:

the default node requirements for this unit (ESSENTIAL, ESSENTIAL_IF_CONNECTED or OPTIONAL)

showParameterPanel

public void showParameterPanel()

Display the parameter panel for this unit. Equivalent to the user double clicking.

hideParameterPanel

public void hideParameterPanel()

getTaskGraphContext

public TaskGraphContext getTaskGraphContext()

setVersion

public void setVersion(java.lang.String version)

getVersion

public java.lang.String getVersion()

log

public void log(java.lang.String msg)

debug

public void debug(java.lang.String msg)

log

public void log(java.lang.String msg,
       java.lang.Throwable t)

debug

public void debug(java.lang.String msg,
         java.lang.Throwable t)