math.calculator

Class MathCalc

java.lang.Object

org.trianacode.taskgraph.Unit

math.calculator.MathCalc

All Implemented Interfaces:

ComputeManager

public class MathCalc
extends Unit
implements ComputeManager

A MathCalc unit to provide an interface to the Compute software

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	defineVariable(java.lang.String undefinedVariable) Prompts the user to define the variable which is currently undefined.
java.lang.String	getHelpFile()
double[]	getInputData(int i) Gets the data from the ith input node from the unit which implements this interface.
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[]	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() Initialses information specific to MathCalc.
void	print(java.lang.String text) Prints the text to the debug stream for the unit.
void	println(java.lang.String text) Prints the text to the debug stream for the unit followed by a line feed.
void	process() ********************************************* ** USER CODE of MathCalc goes here *** ********************************************* MathCalc is unlike most other Units in that it does not itself directly initiate the input of the data.
void	reset() Reset's MathCalc
void	setParameter(java.lang.String name, java.lang.String value) Loads MathCalc's parameters.

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

MathCalc

public MathCalc()

Method Detail

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

defineVariable

public java.lang.String defineVariable(java.lang.String undefinedVariable)

Description copied from interface: ComputeManager

Prompts the user to define the variable which is currently undefined. This allows users to not define things until the equation is run. The user just gets prompted everytime Compute doesn't recognize any constant.

Specified by:

defineVariable in interface ComputeManager

process

public void process()

********************************************* ** USER CODE of MathCalc goes here *** *********************************************

MathCalc is unlike most other Units in that it does not itself directly initiate the input of the data. Instead, the user types an expression into the parameter window. When the user types "Return" the expression is sent to Compute, which parses it and decides what the output type will be and whether input data is needed. (This is indicated by the presence in the expression of identifiers for data from input nodes of the form #0c and #1s etc.) Method process() asks Compute for the answer, and this initiates the actual computation, during which, if data is needed, Compute calls method getInputData below. When the expression has been evaluated it is returned to method process() so that process() can do the output.

Specified by:

process in class Unit

getInputData

public double[] getInputData(int i)

Gets the data from the ith input node from the unit which implements this interface. A double array is returned containing the data. If the length of the data is one then the input data must have been a scaler value, otherwise an array of values is returned.

Specified by:

getInputData in interface ComputeManager

println

public void println(java.lang.String text)

Prints the text to the debug stream for the unit followed by a line feed. This function just returns if there is no debug window.

Specified by:

println in interface ComputeManager

print

public void print(java.lang.String text)

Prints the text to the debug stream for the unit. This function just returns if there is no debug window.

Specified by:

print in interface ComputeManager

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:

an array of the output types for this unit

init

public void init()

Initialses information specific to MathCalc.

Overrides:

init in class Unit

reset

public void reset()

Reset's MathCalc

Overrides:

reset in class Unit

setParameter

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

Loads MathCalc's parameters.

getHelpFile

public java.lang.String getHelpFile()