io.github.fnss

Class Topology

java.lang.Object

io.github.fnss.PropertyContainer

io.github.fnss.Topology

All Implemented Interfaces:

Cloneable

public class Topology
extends PropertyContainer
implements Cloneable

Represent a network topology

Author:

Lorenzo Saino

Constructor Summary

Constructors

Constructor and Description
Topology() Constructor
Topology(boolean directed) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addEdge(String u, String v) Add an edge to the topology.
void	addEdge(String u, String v, Edge edge) Add an edge to the topology.
void	addNode(String v, Node node) Add a node to the topology
Topology	clone() Return a copy of this object
Set<Pair<String,String>>	getAllEdges() Return a set containing all the edge endpoints pair.
Set<String>	getAllNodes() Return a set containing all the node IDs.
String	getBufferUnit() Return the unit of buffer size
String	getCapacityUnit() Return the unit of link capacity
String	getDelayUnit() Return the unit of link delay
String	getDistanceUnit() Return the unit of geographical distance (used for link lengths)
Edge	getEdge(Pair<String,String> endpoints) Return a specific edge in the topology
Edge	getEdge(String u, String v) Return a specific edge in the topology
Node	getNode(String v) Return a specific node of the topology
boolean	isDirected() Return the type of edges
void	makeDirected() Makes this topology directed.
int	numberOfEdges() Return the number of edges in the topology
int	numberOfNodes() Return the number of nodes in the topology
Edge	removeEdge(String u, String v) Remove an edge from the topology
Node	removeNode(String v) Remove a node to the topology.
void	setBufferUnit(String bufferUnit) Set the unit of buffer size
void	setCapacityUnit(String capacityUnit) Set the unit of link capacity
void	setDelayUnit(String delayUnit) Set the unit of link delay
void	setDistanceUnit(String distanceUnit) Set the unit of geographical distance (used for nodes coordinates and link lengths)

Methods inherited from class io.github.fnss.PropertyContainer

getAllProperties, getProperty, hasProperty, removeProperty, setProperty

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Topology

public Topology()

Constructor

Topology

public Topology(boolean directed)

Constructor

Parameters:

directed - true if edges are directed, false otherwise

Method Detail

isDirected

public boolean isDirected()

Return the type of edges

Returns:

true if edges are directed, false

makeDirected

public void makeDirected()

Makes this topology directed. If it is already directed, nothing happens.

getCapacityUnit

public String getCapacityUnit()

Return the unit of link capacity

Returns:

the capacity unit

setCapacityUnit

public void setCapacityUnit(String capacityUnit)

Set the unit of link capacity

Parameters:

capacityUnit - the capacity unit to set

getDelayUnit

public String getDelayUnit()

Return the unit of link delay

Returns:

the delay unit

setDelayUnit

public void setDelayUnit(String delayUnit)

Set the unit of link delay

Parameters:

delayUnit - the delay unit to set

getDistanceUnit

public String getDistanceUnit()

Return the unit of geographical distance (used for link lengths)

Returns:

the distance unit

setDistanceUnit

public void setDistanceUnit(String distanceUnit)

Set the unit of geographical distance (used for nodes coordinates and link lengths)

Parameters:

distanceUnit - the distance unit to set

getBufferUnit

public String getBufferUnit()

Return the unit of buffer size

Returns:

the buffer unit

setBufferUnit

public void setBufferUnit(String bufferUnit)

Set the unit of buffer size

Parameters:

bufferUnit - the buffer unit to set

addNode

public void addNode(String v,
           Node node)

Add a node to the topology

Parameters:

v - The ID of the node

node - The Node object

removeNode

public Node removeNode(String v)

Remove a node to the topology.

Parameters:

v - The ID of the node to remove

Returns:

The Node object removed if it was present in the topology. Otherwise, null is returned

getNode

public Node getNode(String v)

Return a specific node of the topology

Parameters:

v - The ID of the node

Returns:

The selected node, if present. Otherwise null is returned

getAllNodes

public Set<String> getAllNodes()

Return a set containing all the node IDs. To get the Node object of a specific node use getNode(String v)

Returns:

a set with all node IDs of the topology

See Also:

getNode(String)

numberOfNodes

public int numberOfNodes()

Return the number of nodes in the topology

Returns:

the number of nodes

addEdge

public void addEdge(String u,
           String v)

Add an edge to the topology. If the nodes connected by the edge are not present, they are created.

Parameters:

u - The start node

v - The end node

addEdge

public void addEdge(String u,
           String v,
           Edge edge)

Add an edge to the topology. If the nodes connected by the edge are not present, they are created.

Parameters:

u - The start node

v - The end node

edge - The edge object

removeEdge

public Edge removeEdge(String u,
              String v)

Remove an edge from the topology

Parameters:

u - The start node

v - The end node

Returns:

The removed egde, if it was present. Otherwise, null is returned.

getEdge

public Edge getEdge(String u,
           String v)

Return a specific edge in the topology

Parameters:

u - The edge start node

v - The edge end node

Returns:

The selected edge, if present. Otherwise null is returned

getEdge

public Edge getEdge(Pair<String,String> endpoints)

Return a specific edge in the topology

Parameters:

endpoints - a pair containing edge endpoints

Returns:

The selected edge, if present. Otherwise null is returned

getAllEdges

public Set<Pair<String,String>> getAllEdges()

Return a set containing all the edge endpoints pair. To get the Edge object of a specific edge use getEdge(String v, String u)

Returns:

a set with all edge endpoint pairs of the topology

See Also:

getEdge(String, String)

numberOfEdges

public int numberOfEdges()

Return the number of edges in the topology

Returns:

the number of edges

clone

public Topology clone()

Return a copy of this object

Overrides:

clone in class PropertyContainer

Returns:

A copy of this object