triana.types

Class OldUnit

java.lang.Object

org.trianacode.taskgraph.Unit

triana.types.OldUnit

public abstract class OldUnit
extends Unit

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
OldUnit()

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Deprecated.
void	addDescription(java.lang.String text) Deprecated. ??
void	addGUILine(java.lang.String line) Deprecated.
void	allowZeroInputNodes() Deprecated.
void	allowZeroOutputNodes() Deprecated.
void	cleanUp() Deprecated.
void	dispose() This function is called when the unit is deleted.
void	doubleClick() Deprecated.
boolean	getCanProcessDoubleArrays()
java.lang.String	getHelpFile() Deprecated. now set as a parameter in Tool
TrianaType	getInputNode(int nodeNumber) Deprecated.
int	getInputNodes() Deprecated.
java.lang.String[]	getInputTypes() This method should be overridden to return an array of the data input types accepted by this unit (returns triana.types.TrianaType by default).
java.lang.String	getName()
static java.lang.String	getName(java.lang.String nameAndNumber) Deprecated.
static int	getNumber(java.lang.String nameAndNumber) Deprecated.
int	getOutputNodes() Deprecated.
java.lang.String[]	getOutputTypes() This method should be overridden to return an array of the data output types accepted by this unit (returns triana.types.TrianaType by default).
java.lang.String	getPopUpDescription() This returns a brief! description of what the unit does.
boolean	getRequireDoubleInputs()
void	init() This function is called when the unit is first created.
int	inputNodes() Deprecated.
java.lang.String	inputTypes() Deprecated.
boolean	isEssential(int index) A convienience method that returns whether the data input node at the specified index is essential.
boolean	isOptional(int index) A convienience method that returns whether the data input node at the specified index is optional.
void	outputAtNode(int outputNode, TrianaType data) Deprecated.
void	outputAtNodeNonBlocking(int outputNode, TrianaType data) Deprecated.
int	outputNodes() Deprecated.
java.lang.String	outputTypes() Deprecated.
void	parameterUpdate(java.lang.String paramname, java.lang.Object value) Called to update internal unit variables when the value of a parameter changes.
void	print(java.lang.String text) Prints the specific text to the debug window for the MainTriana which this unit is running within.
void	println(java.lang.String text) Prints the specific text to the debug window for the MainTriana which this unit is running within and adds a carriage return to the end of the given string.
abstract void	process() ************************************************************* *********** Programmers implement their code here *********** ************************************************************* If a user wants to include an algorithm into Triana then this method must be implemented and the appropriate algorithm invoked here.
void	reset() This function is called when the reset is pressed on the gui.
void	saveParameter(java.lang.String name, boolean param) Deprecated.
void	saveParameter(java.lang.String name, byte param) Deprecated.
void	saveParameter(java.lang.String name, double param) Deprecated.
void	saveParameter(java.lang.String name, float param) Deprecated.
void	saveParameter(java.lang.String name, int param) Deprecated.
void	saveParameter(java.lang.String name, long param) Deprecated.
void	saveParameter(java.lang.String name, java.lang.String param) Deprecated.
void	saveParameters() Deprecated.
void	setCanProcessDoubleArrays(boolean state) Unit Programmers should set this to true if this unit can process input data sets in double precision format
void	setEssential(int index) A convienience method that sets the data input node at the specified index to essential.
void	setGUIInformation() Deprecated.
void	setOptional(int index) A convienience method that sets the data input node at the specified index to optional.
void	setOutputType(java.lang.Class trianaType) Deprecated.
void	setOutputType(java.lang.String name) Deprecated.
void	setParameter(java.lang.String name, java.lang.String value) Deprecated.
void	setRequireDoubleInputs(boolean state) Unit Programmers should set this to true if this unit requires its inputs to be in double precision format
void	setResizableInputs(boolean b) Deprecated.
void	setResizableOutputs(boolean b) Deprecated.
void	setText(java.lang.String information) Sets the text in the main triana window to the following
void	setUseGUIBuilder(boolean state) Deprecated.
void	starting() Deprecated.
void	stop() Stops the network running
void	stopping() Deprecated.
static boolean	strToBoolean(java.lang.String value) Converts the given String to a boolean.
static boolean[]	strToBooleans(java.lang.String value) Converts the given String to an array of shortcut.
static byte	strToByte(java.lang.String value) Converts the given String to a byte.
static byte[]	strToBytes(java.lang.String value) Converts the given String to an array of byte.
static double	strToDouble(java.lang.String value) Converts the given String to a double.
static double[]	strToDoubles(java.lang.String value) Converts the given String to an array of double.
static float	strToFloat(java.lang.String value) Converts the given String to a float .
static float[]	strToFloats(java.lang.String value) Converts the given String to an array of floats.
static int	strToInt(java.lang.String value) Converts the given String to a int.
static int[]	strToInts(java.lang.String value) Converts the given String to an array of int.
static long	strToLong(java.lang.String value) Converts the given String to a Long.
static long[]	strToLongs(java.lang.String value) Converts the given String to an array of Long.
static short	strToShort(java.lang.String value) Converts the given String to a short.
static short[]	strToShorts(java.lang.String value) Converts the given String to an array of short.
static java.lang.String[]	strToStrings(java.lang.String value) Converts the given String to an array of String containing each string separately.
static java.lang.String	toString(boolean param) Converts an boolean into a String
static java.lang.String	toString(byte param) Converts an byte into a String
static java.lang.String	toString(double param) Converts an double into a String
static java.lang.String	toString(float param) Converts an float into a String
static java.lang.String	toString(int param) Converts an integer into a String
static java.lang.String	toString(long param) Converts an long into a String
static java.lang.String	toString(short param) Converts an short into a String
void	updateGUIParameter(java.lang.String name, java.lang.String value) Deprecated.
void	updateParameter(java.lang.String name, boolean value) Deprecated.
void	updateParameter(java.lang.String name, char value) Deprecated.
void	updateParameter(java.lang.String name, double value) Deprecated.
void	updateParameter(java.lang.String name, float value) Deprecated.
void	updateParameter(java.lang.String name, int value) Deprecated.
void	updateParameter(java.lang.String name, long value) Deprecated.
void	updateParameter(java.lang.String name, short value) Deprecated.
void	updateParameter(java.lang.String name, java.lang.String value) Deprecated.
void	updateWidgetFor(java.lang.String name) Deprecated.

Methods inherited from class org.trianacode.taskgraph.Unit

debug, debug, defineParameter, 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, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

OldUnit

public OldUnit()

Method Detail

getName

public java.lang.String getName()

Returns:

the name of this unit/Class e.g. FFT, Wave, Grapher etc.

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.

Overrides:

init in class Unit

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.

Overrides:

reset in class Unit

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).

Overrides:

dispose in class Unit

process

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

************************************************************* *********** Programmers implement their code here *********** *************************************************************

If a user wants to include an algorithm into Triana then this method must be implemented and the appropriate algorithm invoked here.

This method should always be over-ridden, as if the unit does nothing DEADLOCK occurs!.

Specified by:

process in class Unit

Throws:

java.lang.Exception

getRequireDoubleInputs

public boolean getRequireDoubleInputs()

Returns:

true if this unit requires its inputs to be in double precision format

getCanProcessDoubleArrays

public boolean getCanProcessDoubleArrays()

Returns:

true if this unit can deal with double precision input values

setRequireDoubleInputs

public void setRequireDoubleInputs(boolean state)

Unit Programmers should set this to true if this unit requires its inputs to be in double precision format

setCanProcessDoubleArrays

public void setCanProcessDoubleArrays(boolean state)

Unit Programmers should set this to true if this unit can process input data sets in double precision format

stop

public final void stop()

Stops the network running

getInputNode

public TrianaType getInputNode(int nodeNumber)

Deprecated.

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 node you want to get the data from.

outputAtNode

public void outputAtNode(int outputNode,
                TrianaType data)

Deprecated.

Sets the data at output node outputNode. This method should be used to set the data at each particular output node (if this is necessary) This function would only be used in very few cases. The normal default function is to duplicate the data at all output nodes so hence one call to output() passing the data often suffices.

Parameters:

outputNode - the output node you wish to set

data - the data to be sent

outputAtNodeNonBlocking

public void outputAtNodeNonBlocking(int outputNode,
                           TrianaType data)

Deprecated.

Sets the data at output node outputNode but this call does not block. Use isOutputSent to poll to find out if it has been delivered.

Parameters:

outputNode - the output node you wish to set

data - the data to be sent

See Also:

boolean isOutputSent(int outputNode)

setOutputType

public void setOutputType(java.lang.Class trianaType)

Deprecated.

This method is used to change the type of data that is currently being output from this unit and tells the GUI to redraw its cable so that the new type of information can be seen by a different coloured cable leaving this unit.

setOutputType

public void setOutputType(java.lang.String name)

Deprecated.

This method is used to change the type of data that is currently being output from this unit and tells the GUI to redraw its cable so that the new type of information can be seen by a different coloured cable leaving this unit. Here give the full name of the type e.g. "triana.types.SampleSet"

getInputTypes

public java.lang.String[] getInputTypes()

This method should be overridden to return an array of the data input types accepted by this unit (returns triana.types.TrianaType by default).

Specified by:

getInputTypes in class Unit

Returns:

an array of the input types for this unit

getOutputTypes

public java.lang.String[] getOutputTypes()

This method should be overridden to return an array of the data output types accepted by this unit (returns triana.types.TrianaType by default).

Specified by:

getOutputTypes in class Unit

Returns:

an array of the output types for yhis unit

setOptional

public void setOptional(int index)

A convienience method that sets the data input node at the specified index to optional. This means that the scheduler does not wait for data from the node before continuing with processing. By default input nodes are not set to optional (i.e. they are set to essential).

isOptional

public boolean isOptional(int index)

A convienience method that returns whether the data input node at the specified index is optional. If a node is optional this means that the scheduler does not wait for data from the node before continuing with processing. By default input nodes are not set to optional (i.e. they are set to essential).

setEssential

public void setEssential(int index)

A convienience method that sets the data input node at the specified index to essential. This means that the scheduler does must wait for data from the node before continuing with processing. By default input nodes are not set to essential (this is the opposite of optional).

isEssential

public boolean isEssential(int index)

A convienience method that returns whether the data input node at the specified index is essential. If a node is essential this means that the scheduler must not wait for data from the node before continuing with processing. By default input nodes are set to essential (this is the opposite of optional).

setText

public void setText(java.lang.String information)

Sets the text in the main triana window to the following

print

public void print(java.lang.String text)

Prints the specific text to the debug window for the MainTriana which this unit is running within.

println

public void println(java.lang.String text)

Prints the specific text to the debug window for the MainTriana which this unit is running within and adds a carriage return to the end of the given string.

getPopUpDescription

public java.lang.String getPopUpDescription()

This returns a brief! description of what the unit does. The text here is shown in a pop up window when the user puts the mouse over the unit icon for more than a second.

Overrides:

getPopUpDescription in class Unit

getHelpFile

public java.lang.String getHelpFile()

Deprecated. now set as a parameter in Tool

This function must be implemented for each Triana unit to specify the help file for this unit. We really must insist that people write help files in order to keep Triana as user-friendly as possible! Help files should be written in html format. If not, they will displayed in text format. You can simply enter the name of the unit (.html) and then Triana looks for this help file in several places e.g. :-

1. in $GRIDHOME/doc/help and then within the tool and main subdirectories.
2. in the users getApplicationDataDir directory within a directory called help and then within the tool and main subdirectories.
3. Any path specified by the GRID_HELP environment variable and also then within the tool and main subdirectories.

   You can alternatively enter the location as an absolute path name or a network address e.g.

   "http:///www.astro.cf.ac.uk/pub/Ian.Taylor/Triana/Help/Wave.html"
   or
   "/usr/local/ian/Triana/Help/Wave.html"
   

   If you don't wan't to provide help (!!!) the this function should return the String "none" or null.

Returns:

the location of the help file for this unit.

parameterUpdate

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

Called to update internal unit variables when the value of a parameter changes. Whether this is called immediately the parameter is updates, or just before the process method depends on the units param update policy.

Overrides:

parameterUpdate in class Unit

toString

public static final java.lang.String toString(int param)

Converts an integer into a String

toString

public static final java.lang.String toString(long param)

Converts an long into a String

toString

public static final java.lang.String toString(float param)

Converts an float into a String

toString

public static final java.lang.String toString(short param)

Converts an short into a String

toString

public static final java.lang.String toString(double param)

Converts an double into a String

toString

public static final java.lang.String toString(byte param)

Converts an byte into a String

toString

public static final java.lang.String toString(boolean param)

Converts an boolean into a String

strToFloat

public static final float strToFloat(java.lang.String value)

Converts the given String to a float .

strToDouble

public static final double strToDouble(java.lang.String value)

Converts the given String to a double.

strToInt

public static final int strToInt(java.lang.String value)

Converts the given String to a int.

strToShort

public static final short strToShort(java.lang.String value)

Converts the given String to a short.

strToLong

public static final long strToLong(java.lang.String value)

Converts the given String to a Long.

strToByte

public static final byte strToByte(java.lang.String value)

Converts the given String to a byte.

strToBoolean

public static final boolean strToBoolean(java.lang.String value)

Converts the given String to a boolean.

strToFloats

public static final float[] strToFloats(java.lang.String value)

Converts the given String to an array of floats.

strToDoubles

public static final double[] strToDoubles(java.lang.String value)

Converts the given String to an array of double.

strToInts

public static final int[] strToInts(java.lang.String value)

Converts the given String to an array of int. Each value is separated by a single white space

strToShorts

public static final short[] strToShorts(java.lang.String value)

Converts the given String to an array of short.

strToLongs

public static final long[] strToLongs(java.lang.String value)

Converts the given String to an array of Long.

strToBytes

public static final byte[] strToBytes(java.lang.String value)

Converts the given String to an array of byte.

strToBooleans

public static final boolean[] strToBooleans(java.lang.String value)

Converts the given String to an array of shortcut. boolean.

strToStrings

public static final java.lang.String[] strToStrings(java.lang.String value)

Converts the given String to an array of String containing each string separately.

saveParameters

public void saveParameters()

Deprecated.

setParameter

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

Deprecated.

Use getTask().setParameter() instead

updateWidgetFor

public void updateWidgetFor(java.lang.String name)

Deprecated.

inputTypes

public java.lang.String inputTypes()

Deprecated.

outputTypes

public java.lang.String outputTypes()

Deprecated.

addDescription

public void addDescription(java.lang.String text)

Deprecated. ??

Add the description directly to the triana type

inputNodes

public int inputNodes()

Deprecated.

Use getTask().getDataInputNodeCount() instead.

outputNodes

public int outputNodes()

Deprecated.

Use getTask().getDataOutputNodeCount() instead.

getInputNodes

public int getInputNodes()

Deprecated.

Use getTask().getDataInputNodeCount() instead.

getOutputNodes

public int getOutputNodes()

Deprecated.

Use getTask().getDataOutputNodeCount() instead.

setResizableInputs

public void setResizableInputs(boolean b)

Deprecated.

Use setMinimumInputNodes() and setMaximumInputNodes() instead

setResizableOutputs

public void setResizableOutputs(boolean b)

Deprecated.

Use setMinimumOutputNodes() and setMaximumOutputNodes() instead

stopping

public void stopping()

Deprecated.

Description copied from class: Unit

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

Overrides:

stopping in class Unit

starting

public void starting()

Deprecated.

setUseGUIBuilder

public void setUseGUIBuilder(boolean state)

Deprecated.

Use setGUIBuilderInformation() instead.

setGUIInformation

public void setGUIInformation()

Deprecated.

addGUILine

public void addGUILine(java.lang.String line)

Deprecated.

Use setGUIBuilderInformation() instead.

doubleClick

public void doubleClick()

Deprecated.

DON'T USE

cleanUp

public void cleanUp()

Deprecated.

Override dispose instead

allowZeroInputNodes

public void allowZeroInputNodes()

Deprecated.

Use setMinimumInputNodes() instead.

allowZeroOutputNodes

public void allowZeroOutputNodes()

Deprecated.

Use setMinimumOutputNodes() instead.

saveParameter

public void saveParameter(java.lang.String name,
                 int param)

Deprecated.

saveParameter

public void saveParameter(java.lang.String name,
                 java.lang.String param)

Deprecated.

saveParameter

public void saveParameter(java.lang.String name,
                 long param)

Deprecated.

saveParameter

public void saveParameter(java.lang.String name,
                 float param)

Deprecated.

saveParameter

public void saveParameter(java.lang.String name,
                 double param)

Deprecated.

saveParameter

public void saveParameter(java.lang.String name,
                 byte param)

Deprecated.

saveParameter

public void saveParameter(java.lang.String name,
                 boolean param)

Deprecated.

updateParameter

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

Deprecated.

Use getTask().setParameter() instead.

updateGUIParameter

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

Deprecated.

Use getTask().setParameter() instead.

updateParameter

public void updateParameter(java.lang.String name,
                   int value)

Deprecated.

Use getTask().setParameter() instead.

updateParameter

public void updateParameter(java.lang.String name,
                   long value)

Deprecated.

Use getTask().setParameter() instead.

updateParameter

public void updateParameter(java.lang.String name,
                   short value)

Deprecated.

Use getTask().setParameter() instead.

updateParameter

public void updateParameter(java.lang.String name,
                   boolean value)

Deprecated.

Use getTask().setParameter() instead.

updateParameter

public void updateParameter(java.lang.String name,
                   float value)

Deprecated.

Use getTask().setParameter() instead.

updateParameter

public void updateParameter(java.lang.String name,
                   double value)

Deprecated.

Use getTask().setParameter() instead.

updateParameter

public void updateParameter(java.lang.String name,
                   char value)

Deprecated.

Use getTask().setParameter() instead.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Deprecated.

For backwardly compatability ONLY

getName

public static final java.lang.String getName(java.lang.String nameAndNumber)

Deprecated.

Parameters:

nameAndNumber - the name and the number in one string e.g. node1

Returns:

the name of the parameter which is tagged along with a number to identify different instances of it.

getNumber

public static final int getNumber(java.lang.String nameAndNumber)

Deprecated.

Parameters:

nameAndNumber - the name and the number in one string e.g. node1

Returns:

the value of the integer which is tagged along at the end of given name. Could do this yourself but this is a short cut. Useful when loading back lists of parametes e.g. node1, node2, node3 etc .....