org.trianacode.taskgraph.service

Interface RunnableInterface

All Superinterfaces:

ClipableTaskInterface

All Known Implementing Classes:

RunnableTask

public interface RunnableInterface
extends ClipableTaskInterface

The interface used by Unit to access RunnableTask. RunnableTasks implement the data handling capability of a Task.

Method Summary

Methods

Modifier and Type	Method and Description
ControlInterface	getControlInterface()
java.lang.Object	getInput(int nodeNumber) Returns the data at input node nodeNumber.
Task	getTask()
ToolTable	getToolTable()
boolean	isInput(int nodeNumber)
boolean	isOutputSent(int outputNode)
void	notifyError(java.lang.String message) called by a Unit when an error occurs
void	output(int outputNode, java.lang.Object data, boolean blocking) Outputs the data to the given node outputNode.
void	output(java.lang.Object data) Outputs the data across all nodes.

Methods inherited from interface org.trianacode.taskgraph.service.ClipableTaskInterface

extractClipInState, getClipIn, getClipIn, isClipInName, putClipIn, queueClipIn, removeClipIn, restoreClipInState

Method Detail

getTask

Task getTask()

Returns:

an interface to the task

getControlInterface

ControlInterface getControlInterface()

Returns:

an control interface to the scheduler (returns null if the task is not a control task)

isInput

boolean isInput(int nodeNumber)

Returns:

true if there is data waiting on the specified node

getInput

java.lang.Object getInput(int nodeNumber)
                          throws OutOfRangeException,
                                 EmptyingException,
                                 NotCompatibleException

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.

Returns:

the data input at node nodeNumber

Throws:

OutOfRangeException

EmptyingException

NotCompatibleException

output

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.

Parameters:

data - the data to be sent

output

void output(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, otherwise, if non-blocking, isOutputSent() can be used to poll whether the data has been successfully sent. This method is used to set the data at each particular output node if this is necessary, otherwise use output(Object data) to copy the data across all nodes.

Parameters:

outputNode - the output node you wish to set

data - the data to be sent

isOutputSent

boolean isOutputSent(int outputNode)

Returns:

true if the data sent with the send call has reached its destination

notifyError

void notifyError(java.lang.String message)

called by a Unit when an error occurs

getToolTable

ToolTable getToolTable()

Returns:

a table of the currently loaded tools