de.fhstralsund.vinets.structure
Interface Port

All Superinterfaces:
java.lang.Cloneable, NetElement, Node, java.io.Serializable

public interface Port
extends Node

A Port object models an entry/exit point of a Link to a Node. It is a special atomar Node. Any Port is located on the outer border of its host Block. A Port is connected to an inner and/or an outer Link. The inner Link has the same host as this Port, the outer Link has the host Graph of the host Block of this Port as its host. The connection between a Port and its (inner or outer) Link is set up when the Link is created. A Port and its Link should never disconnect again.


Method Summary
 Link getInnerLink()
          Delivers the Link connected to this Port from inside the Block this Port belongs to.
 Link getOuterLink()
          Delivers the Link connected to this Port from outside the Block this Port belongs to.
 PortType getPortType()
          Delivers the Type of this Port.
 boolean isInput()
          Indicates input direction of the connected Links.
 boolean isNeutral()
          Indicates that the connected inner / outer Link is undirected.
 boolean isOutput()
          Indicates output direction of the connected Links.
 
Methods inherited from interface de.fhstralsund.vinets.structure.Node
degree, getNodeType, inArcs, incidentEdges, indegree, isAtomar, outArcs, outdegree, undirectedEdges
 
Methods inherited from interface de.fhstralsund.vinets.structure.NetElement
clearLabels, containsLabel, getBooleanLabel, getData, getDoubleLabel, getGeometry, getHost, getID, getIntLabel, getLabel, getLabelKeySet, getName, getOriginal, getRepresentation, removeLabel, setBooleanLabel, setData, setDoubleLabel, setGeometry, setIntLabel, setLabel, setName, setRepresentation
 

Method Detail

isInput

boolean isInput()
Indicates input direction of the connected Links. The connected inner / outer Link goes from outside into the host Block of this Port.

Returns:
true if this Port is an input into the Block.

isOutput

boolean isOutput()
Indicates output direction of the connected Links. The connected inner / outer Link leave the host Block of this Port to the outside.

Returns:
true if this Port is an output from the Block.

isNeutral

boolean isNeutral()
Indicates that the connected inner / outer Link is undirected.

Returns:
true if this Port has no direction.

getInnerLink

Link getInnerLink()
Delivers the Link connected to this Port from inside the Block this Port belongs to. The Block is the host of both the Link and this Port.

Returns:
the Link connected to the Port from inside its host.

getOuterLink

Link getOuterLink()
Delivers the Link connected to this Port from outside the Block this Port belongs to. The Block is the host of this Port, while the Link and the Block have the same host.

Returns:
the Link connected to the Port from outside its host.

getPortType

PortType getPortType()
Delivers the Type of this Port.

Returns:
the Type of this Port