SuperNodeDiagram Objects

Subclass of Diagram.

This is the diagram used by SuperNode objects to store nodes. It allows connections between the two pseudo nodes, (the input connector and output connector) and other nodes in the diagram to be edited.

s.disconnectInputConnector()

Removes any direct links between the diagram's input connector and other nodes in the diagram. If the SuperNode is an initial node and therefore doesn't have an input connector, this method does nothing.

Exceptions:

ObjectLockedException : if the diagram is currently locked

s.disconnectOutputConnector()

Removes any direct links between the diagram's output connector and other nodes in the diagram. If the SuperNode is an terminal node and therefore doesn't have an input connector, this method does nothing.

Exceptions:

ObjectLockedException : if the diagram is currently locked

s.getInputConnector() : Node

Returns the input connector from this diagram, or None if the diagram belongs to an initial node and has no input connector.

s.getOutputConnector() : Node

Returns the output connector from this diagram, or None if the diagram belongs to a terminal node and has no output connector.

s.linkFromInputConnector(node)
node (Node) : 

Creates a link from the input connector to the supplied node.

Exceptions:

OwnerException : if any objects in the path are not owned by this diagram

ObjectLockedException : if the diagram is currently locked

InvalidEditException : if the connection would be invalid

s.linkToOutputConnector(node)
node (Node) : 

Creates a link from the supplied node to the output connector.

Exceptions:

OwnerException : if any objects in the path are not owned by this diagram

ObjectLockedException : if the diagram is currently locked

InvalidEditException : if the connection would be invalid

s.runAll(results) : ExecutionHandle

results (Collection) : an empty collection that will contain any built objects once execution has completed

Executes the executable nodes within this sub-stream synchronously and waits for it to complete. Returns an ExecutionHandle which can be used to access the exit status and any result from the task.

Note that this should only be called on a terminal SuperNode.

Exceptions:

OwnerException : if the stream was not created by this session

ObjectLockedException : if the stream is locked

ServerConnectionException : if the stream is not connected to a server

SessionException : if the session is already running another task, cannot execute the task or if execution completes in a state other than SUCCESS

s.runSelected(nodes, results) : ExecutionHandle

nodes (Node[]) : the array of Node objects to be executed

results (Collection) : an empty collection that will contain any built objects once execution has completed

Executes the supplied array of nodes synchronously and waits for them to complete. There must be at least one node in the array. Returns an ExecutionHandle which can be used to access the exit status and any result from the task.

Note that this should only be called on a terminal SuperNode.

Exceptions:

OwnerException : if the nodes are not all owned by this stream

ObjectLockedException : if the stream is locked

ServerConnectionException : if the stream is not connected to a server

SessionException : if the session is already running a stream, another task, cannot execute the task or if execution completes in a state other than SUCCESS

IllegalArgumentException : if the array is empty

s.unlinkFromInputConnector(node)
node (Node) : 

Removes any direct link from the input connector to the supplied node.

Exceptions:

OwnerException : if any objects in the path are not owned by this diagram

ObjectLockedException : if the diagram is currently locked

InvalidEditException : if the connection would be invalid

s.unlinkToOutputConnector(node)
node (Node) : 

Removes any direct link from the supplied node to the output connector.

Exceptions:

OwnerException : if any objects in the path are not owned by this diagram

ObjectLockedException : if the diagram is currently locked

InvalidEditException : if the connection would be invalid