ca.uqac.lif.dag

Interface Connectable

All Known Subinterfaces:

Function

All Known Implementing Classes:

AbsoluteValue, Addition, And, AndNode, AtomicFunction, BooleanConnective, Circuit, Constant, ElementAt, Equals, Eventually, Filter, Fork, GetSize, Globally, IfThenElse, InstanceOf, IsGreaterThan, LabelledNode, Multiplication, NestedNode, Next, Node, Not, NumberCast, Or, OrNode, ParameterizedVectorFunction, PartNode, Split, Subtraction, Triangle.AllNumbers, Triangle.AllPositive, Triangle.IsPositive, Triangle.IsValidTriangle, Triangle.TriangleInequality, UnaryOperator, UnknownNode, VectorAnd, VectorApply, VectorBooleanConnective, VectorFunction, VectorOr, VectorOutputFunction, VectorProduct, VectorSum, Window

public interface Connectable

Interface implemented by any object having input and output pins.

Author:

Sylvain Hallé

Method Summary

Modifier and Type	Method and Description
void	addToInput(int index, Pin<? extends Node> pin) Adds a node's output pin to the set of connections of this node's input pin.
void	addToOutput(int index, Pin<? extends Node> pin) Adds a node's input pin to the set of connections of this node's output pin.
int	getInputArity() Gets the input arity of the node.
java.util.Collection<Pin<? extends Node>>	getInputLinks(int index) Gets the output pins of other nodes that are connected to a given input pin of this node.
Pin<? extends Node>	getInputPin(int index) Gets the node's input pin for a given index.
int	getOutputArity() Gets the output arity of the node.
java.util.Collection<Pin<? extends Node>>	getOutputLinks(int index) Gets the input pins of other nodes that are connected to a given output pin of this node.
Pin<? extends Node>	getOutputPin(int index) Gets the node's input pin for a given index.
void	removeFromInput(int index, Pin<? extends Node> pin) Removes a node's output pin to the set of connections of this node's input pin.
void	removeFromOutput(int index, Pin<? extends Node> pin) Removes a node's input pin to the set of connections of this node's output pin.
void	setToInput(int index, Pin<? extends Node> pin) Sets a node's output pin as the connection of this node's input pin.
void	setToOutput(int index, Pin<? extends Node> pin) Sets a node's input pin as the connection of this node's output pin.

Method Detail

getInputArity

int getInputArity()

Gets the input arity of the node. The input arity is the number of input pins of this node.

Returns:

The input arity

getOutputArity

int getOutputArity()

Gets the output arity of the node. The input arity is the number of output pins of this node.

Returns:

The input arity

getInputLinks

java.util.Collection<Pin<? extends Node>> getInputLinks(int index)
                                                 throws java.lang.IndexOutOfBoundsException

Gets the output pins of other nodes that are connected to a given input pin of this node.

Parameters:

index - The index of the current node's input pin

Returns:

The collection of output pins of other nodes

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's input arity

getOutputLinks

java.util.Collection<Pin<? extends Node>> getOutputLinks(int index)
                                                  throws java.lang.IndexOutOfBoundsException

Gets the input pins of other nodes that are connected to a given output pin of this node.

Parameters:

index - The index of the current node's output pin

Returns:

The collection of input pins of other nodes

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's output arity

addToInput

void addToInput(int index,
                Pin<? extends Node> pin)
         throws java.lang.IndexOutOfBoundsException

Adds a node's output pin to the set of connections of this node's input pin. If other pins are already associated to this input pin, they are kept.

Parameters:

index - The index of the current node's input pin

pin - A node's output pin to add to the connections

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's input arity

setToInput

void setToInput(int index,
                Pin<? extends Node> pin)
         throws java.lang.IndexOutOfBoundsException

Sets a node's output pin as the connection of this node's input pin. If other pins are already associated to this input pin, they are deleted.

Parameters:

index - The index of the current node's input pin

pin - A node's output pin to add to the connections

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's input arity

removeFromInput

void removeFromInput(int index,
                     Pin<? extends Node> pin)
              throws java.lang.IndexOutOfBoundsException

Removes a node's output pin to the set of connections of this node's input pin. If other pins are already associated to this input pin, they are kept.

Parameters:

index - The index of the current node's input pin

pin - A node's output pin to remove from the connections

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's input arity

addToOutput

void addToOutput(int index,
                 Pin<? extends Node> pin)
          throws java.lang.IndexOutOfBoundsException

Adds a node's input pin to the set of connections of this node's output pin. If other pins are already associated to this output pin, they are kept.

Parameters:

index - The index of the current node's output pin

pin - A node's input pin to add to the connections

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's output arity

setToOutput

void setToOutput(int index,
                 Pin<? extends Node> pin)
          throws java.lang.IndexOutOfBoundsException

Sets a node's input pin as the connection of this node's output pin. If other pins are already associated to this output pin, they are deleted.

Parameters:

index - The index of the current node's output pin

pin - A node's input pin to add to the connections

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's output arity

removeFromOutput

void removeFromOutput(int index,
                      Pin<? extends Node> pin)
               throws java.lang.IndexOutOfBoundsException

Removes a node's input pin to the set of connections of this node's output pin. If other pins are already associated to this output pin, they are kept.

Parameters:

index - The index of the current node's output pin

pin - A node's input pin to remove from the connections

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's output arity

getInputPin

Pin<? extends Node> getInputPin(int index)
                         throws java.lang.IndexOutOfBoundsException

Gets the node's input pin for a given index.

Parameters:

index - The index

Returns:

The pin

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's input arity

getOutputPin

Pin<? extends Node> getOutputPin(int index)
                          throws java.lang.IndexOutOfBoundsException

Gets the node's input pin for a given index.

Parameters:

index - The index

Returns:

The pin

Throws:

java.lang.IndexOutOfBoundsException - If the index is incompatible with the node's output arity