io.github.fnss

Class TrafficMatrix

java.lang.Object

io.github.fnss.TrafficMatrix

All Implemented Interfaces:

Iterable<Pair<String,String>>

public class TrafficMatrix
extends Object
implements Iterable<Pair<String,String>>

Represent a traffic matrix (referring to a single time interval)

Author:

Lorenzo Saino

Constructor Summary

Constructors

Constructor and Description
TrafficMatrix(String volumeUnit) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addFlow(String origin, String destination, float volume) Add a flow to the matrix
Set<String>	getDestinations() Return a set containing all traffic destinations of the matrix
float	getFlow(String origin, String destination) Return the traffic volume of a specific flow
Set<Pair<String,String>>	getODPairs() Return a pair of all origin-destination (OD) pairs of the matrix
Set<String>	getOrigins() Return a set containing all traffic origins of the matrix
String	getVolumeUnit() Return the unit of traffic volumes
Iterator<Pair<String,String>>	iterator() Return an iterator over the OD pairs of matrix
void	removeFlow(String origin, String destination) Remove a flow from the matrix
void	setVolumeUnit(String volumeUnit) Set the unit of traffic volumes
int	size() Return the number of flows in the matrix

Methods inherited from class java.lang.Object

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

Constructor Detail

TrafficMatrix

public TrafficMatrix(String volumeUnit)

Constructor

Parameters:

volumeUnit - the unit of traffic volumes

Method Detail

size

public int size()

Return the number of flows in the matrix

Returns:

The number of flows in the matrix

getVolumeUnit

public String getVolumeUnit()

Return the unit of traffic volumes

Returns:

the volume unit

setVolumeUnit

public void setVolumeUnit(String volumeUnit)

Set the unit of traffic volumes

Parameters:

volumeUnit - the volume unit to set

getFlow

public float getFlow(String origin,
            String destination)

Return the traffic volume of a specific flow

Parameters:

origin - The origin of the flow

destination - The destination of the flow

Returns:

The volume of traffic

addFlow

public void addFlow(String origin,
           String destination,
           float volume)

Add a flow to the matrix

Parameters:

volume - The volume of traffic

origin - The origin of the flow

destination - The destination of the flow

removeFlow

public void removeFlow(String origin,
              String destination)

Remove a flow from the matrix

Parameters:

origin - The origin of the flow

destination - The destination of the flow

getODPairs

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

Return a pair of all origin-destination (OD) pairs of the matrix

Returns:

a Set of OD pairs

getOrigins

public Set<String> getOrigins()

Return a set containing all traffic origins of the matrix

Returns:

the traffic origins

getDestinations

public Set<String> getDestinations()

Return a set containing all traffic destinations of the matrix

Returns:

the traffic destinations

iterator

public Iterator<Pair<String,String>> iterator()

Return an iterator over the OD pairs of matrix

Specified by:

iterator in interface Iterable<Pair<String,String>>

Returns:

the iterator