com.net2plan.interfaces.cacSimulation

Class ConnectionNetState

java.lang.Object

SimState

com.net2plan.interfaces.cacSimulation.ConnectionNetState

public final class ConnectionNetState
extends SimState

Represents the current state of a network within the connection-admission-control simulation: active connections, current traffic per link...

Important: Users only should use this class only for queries via getX() methods, since kernel is in charge of modifying the network state using the events (CACEvent) scheduled by the event generator (see IConnectionEventGenerator) and the actions (see CACAction) provided by the event processor (see ICACAlgorithm).

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Constructor Summary

Constructors

Constructor and Description
ConnectionNetState(NetPlan netPlan) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkValidity(java.util.Map<java.lang.String,java.lang.String> net2planParameters, boolean allowLinkOversubscription, boolean allowExcessCarriedTraffic)
NetPlan	convertToNetPlan() Returns a network design from the current network state.
ConnectionNetState	copy() Returns a deep copy of the current state.
double	getConnectionArrivalTime(long connId) Returns the arrival time of the specified connection.
java.lang.String	getConnectionAttribute(long connId, java.lang.String key) Returns the value of a given attribute for a connection route.
java.util.Map<java.lang.String,java.lang.String>	getConnectionAttributes(long connId) Returns the set of attributes of a given connection.
double	getConnectionCurrentCarriedTrafficInErlangs(long connId) Returns the current traffic volume for a given connection.
int	getConnectionDemand(long connId) Returns the demand identifier for a given connection.
double	getConnectionDuration(long connId) Returns the duration of the specified connection.
long[]	getConnectionIds() Returns the set of active connection identifiers (in ascending order).
long	getConnectionNextId() Returns the connection identifier for the next created connection.
double	getConnectionRequestedTrafficInErlangs(long connId) Returns the requested traffic volume for a given connection.
java.lang.String	getConnectionRouteAttribute(long connRouteId, java.lang.String key) Returns the value of a given attribute for a connection route.
java.util.Map<java.lang.String,java.lang.String>	getConnectionRouteAttributes(long connRouteId) Returns the set of attributes of a given connection route.
double	getConnectionRouteCarriedTrafficInErlangs(long connRouteId) Returns the current traffic volume for a given connection route.
long	getConnectionRouteConnection(long connRouteId) Returns the connection identifier for the given connection route.
long[]	getConnectionRouteIds() Returns the set of active connection route identifiers (in ascending order).
long	getConnectionRouteNextId() Returns the connection identifier for the next created connection route.
long[]	getConnectionRoutes(long connId) Returns the connection route identifiers associated to the connection.
int[]	getConnectionRouteSequenceOfLinks(long connRouteId) Returns the sequence of links traversed by a given connection route.
double[]	getDemandCurrentCarriedTrafficInErlangsVector() Returns a vector with the carried traffic per demand.
long[]	getDemandCurrentConnections(int demandId) Returns the set of connection ids associated to a given demand.
int[]	getDemandCurrentNumberOfConnectionsVector() Returns the number of current active connections per each demand.
double[]	getDemandCurrentOfferedTrafficInErlangsVector() Returns a vector with the offered traffic per demand.
double[]	getLinkCurrentCarriedTrafficInErlangsVector() Returns a vector with the carried traffic per link.
int[]	getLinkCurrentNumberOfTraversingConnectionRoutesVector() Returns the number of current traversing connection routes per each link.
double[]	getLinkCurrentSpareCapacityInErlangsVector() Returns a vector with the spare capacity per link.
long[]	getLinkCurrentTraversingConnectionRoutes(int linkId) Returns the list of connection routes traversing the given link.
double[]	getNodeCurrentEgressTrafficInErlangsVector() Returns the current egress traffic from each node.
double[]	getNodeCurrentIngressTrafficInErlangsVector() Returns the current ingress traffic to each node.
double[]	getNodeCurrentTraversingTrafficInErlangsVector() Returns the current traffic traversing each node.
int	getNumberOfConnectionRoutes() Returns the number of active connection routes in the network.
int	getNumberOfConnections() Returns the number of active connections in the network.
boolean	hasConnectionRoutes() Returns true if the network has at least one active connection.
boolean	hasConnections() Returns true if the network has at least one active connection.
boolean	isActiveConnection(long connId) Returns true if the given connection is active.
boolean	isActiveConnectionRoute(long connRoute) Returns true if the given connection route is active.
void	reset() Resets the state of the network.
ConnectionNetState	unmodifiableView() Returns an unmodifiable view of the network.
java.lang.Object	update(SimEvent event, java.util.List actions) Update the network state.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionNetState

public ConnectionNetState(NetPlan netPlan)

Default constructor.

Parameters:

netPlan - Complete network design (including traffic demands)

Since:

0.2.0

Method Detail

convertToNetPlan

public NetPlan convertToNetPlan()

Returns a network design from the current network state.

Returns:

Network design

Since:

0.2.1

checkValidity

public void checkValidity(java.util.Map<java.lang.String,java.lang.String> net2planParameters,
                 boolean allowLinkOversubscription,
                 boolean allowExcessCarriedTraffic)

copy

public ConnectionNetState copy()

Returns a deep copy of the current state.

Returns:

Deep copy of the current state

Since:

0.2.0

unmodifiableView

public ConnectionNetState unmodifiableView()

Returns an unmodifiable view of the network.

Returns:

An unmodifiable view of the network

Since:

0.2.0

getConnectionArrivalTime

public double getConnectionArrivalTime(long connId)

Returns the arrival time of the specified connection.

Parameters:

connId - Connection identifier

Returns:

Arrival time

Since:

0.2.0

getConnectionAttribute

public java.lang.String getConnectionAttribute(long connId,
                                      java.lang.String key)

Returns the value of a given attribute for a connection route. If not defined, it is search for the network.

Parameters:

connId - Connection identifier

key - Attribute name

Returns:

Attribute value (or null, if not defined)

Since:

0.2.3

getConnectionAttributes

public java.util.Map<java.lang.String,java.lang.String> getConnectionAttributes(long connId)

Returns the set of attributes of a given connection.

Parameters:

connId - Connection identifier

Returns:

Connection attributes

Since:

0.2.3

getConnectionCurrentCarriedTrafficInErlangs

public double getConnectionCurrentCarriedTrafficInErlangs(long connId)

Returns the current traffic volume for a given connection.

Parameters:

connId - Connection identifier

Returns:

Current traffic volume

Since:

0.2.0

getConnectionDemand

public int getConnectionDemand(long connId)

Returns the demand identifier for a given connection.

Parameters:

connId - Connection identifier

Returns:

Demand identifier

Since:

0.2.0

getConnectionDuration

public double getConnectionDuration(long connId)

Returns the duration of the specified connection.

Parameters:

connId - Connection identifier

Returns:

Duration

Since:

0.2.0

getConnectionIds

public long[] getConnectionIds()

Returns the set of active connection identifiers (in ascending order).

Returns:

Active connection identifiers

Since:

0.2.0

getConnectionNextId

public long getConnectionNextId()

Returns the connection identifier for the next created connection.

Returns:

Connection identifier for the next created connection

Since:

0.2.3

getConnectionRouteAttribute

public java.lang.String getConnectionRouteAttribute(long connRouteId,
                                           java.lang.String key)

Returns the value of a given attribute for a connection route. If not defined, it is search for the network.

Parameters:

connRouteId - Connection route identifier

key - Attribute name

Returns:

Attribute value (or null, if not defined)

Since:

0.2.3

getConnectionRouteAttributes

public java.util.Map<java.lang.String,java.lang.String> getConnectionRouteAttributes(long connRouteId)

Returns the set of attributes of a given connection route.

Parameters:

connRouteId - Connection route identifier

Returns:

Connection route attributes

Since:

0.2.3

getConnectionRouteCarriedTrafficInErlangs

public double getConnectionRouteCarriedTrafficInErlangs(long connRouteId)

Returns the current traffic volume for a given connection route.

Parameters:

connRouteId - Connection route identifier

Returns:

Current traffic volume

Since:

0.2.3

getConnectionRouteIds

public long[] getConnectionRouteIds()

Returns the set of active connection route identifiers (in ascending order).

Returns:

Active connection route identifiers

Since:

0.2.0

getConnectionRequestedTrafficInErlangs

public double getConnectionRequestedTrafficInErlangs(long connId)

Returns the requested traffic volume for a given connection.

Parameters:

connId - Connection identifier

Returns:

Requested traffic volume

Since:

0.2.0

getConnectionRouteConnection

public long getConnectionRouteConnection(long connRouteId)

Returns the connection identifier for the given connection route.

Parameters:

connRouteId - Connection route identifier

Returns:

Connection identifier

Since:

0.2.3

getConnectionRouteNextId

public long getConnectionRouteNextId()

Returns the connection identifier for the next created connection route.

Returns:

Connection identifier for the next created connection route

Since:

0.2.3

getConnectionRoutes

public long[] getConnectionRoutes(long connId)

Returns the connection route identifiers associated to the connection.

Parameters:

connId - Connection identifier

Returns:

Connection route identifiers

Since:

0.2.3

getConnectionRouteSequenceOfLinks

public int[] getConnectionRouteSequenceOfLinks(long connRouteId)

Returns the sequence of links traversed by a given connection route.

Parameters:

connRouteId - Connection route identifier

Returns:

List of links and traversed by the connection route

Since:

0.2.3

getDemandCurrentConnections

public long[] getDemandCurrentConnections(int demandId)

Returns the set of connection ids associated to a given demand.

Parameters:

demandId - Demand identifier

Returns:

Set of connection ids associated to that demand

Since:

0.2.0

getDemandCurrentCarriedTrafficInErlangsVector

public double[] getDemandCurrentCarriedTrafficInErlangsVector()

Returns a vector with the carried traffic per demand.

Returns:

Vector with the carried traffic per demand

Since:

0.2.0

getDemandCurrentOfferedTrafficInErlangsVector

public double[] getDemandCurrentOfferedTrafficInErlangsVector()

Returns a vector with the offered traffic per demand.

Returns:

Vector with the offered traffic per demand

Since:

0.2.0

getDemandCurrentNumberOfConnectionsVector

public int[] getDemandCurrentNumberOfConnectionsVector()

Returns the number of current active connections per each demand.

Returns:

Number of current active connections per each demand

Since:

0.2.2

getLinkCurrentCarriedTrafficInErlangsVector

public double[] getLinkCurrentCarriedTrafficInErlangsVector()

Returns a vector with the carried traffic per link.

Returns:

Vector with the carried traffic per link

Since:

0.2.0

getLinkCurrentNumberOfTraversingConnectionRoutesVector

public int[] getLinkCurrentNumberOfTraversingConnectionRoutesVector()

Returns the number of current traversing connection routes per each link.

Returns:

Number of current traversing connection routes per each link

Since:

0.2.3

getLinkCurrentSpareCapacityInErlangsVector

public double[] getLinkCurrentSpareCapacityInErlangsVector()

Returns a vector with the spare capacity per link.

Returns:

Vector with the spare capacity per link

Since:

0.2.2

getLinkCurrentTraversingConnectionRoutes

public long[] getLinkCurrentTraversingConnectionRoutes(int linkId)

Returns the list of connection routes traversing the given link.

Parameters:

linkId - Link identifier

Returns:

List of connection routes traversing the given link

Since:

0.2.3

getNodeCurrentEgressTrafficInErlangsVector

public double[] getNodeCurrentEgressTrafficInErlangsVector()

Returns the current egress traffic from each node.

Returns:

Current egress traffic from each node

Since:

0.2.0

getNodeCurrentIngressTrafficInErlangsVector

public double[] getNodeCurrentIngressTrafficInErlangsVector()

Returns the current ingress traffic to each node.

Returns:

Current ingress traffic to each node

Since:

0.2.0

getNodeCurrentTraversingTrafficInErlangsVector

public double[] getNodeCurrentTraversingTrafficInErlangsVector()

Returns the current traffic traversing each node.

Returns:

Current traffic traversing each node

Since:

0.2.0

getNumberOfConnections

public int getNumberOfConnections()

Returns the number of active connections in the network.

Returns:

Number of active connections

Since:

0.2.0

getNumberOfConnectionRoutes

public int getNumberOfConnectionRoutes()

Returns the number of active connection routes in the network.

Returns:

Number of active connection routes

Since:

0.2.3

hasConnections

public boolean hasConnections()

Returns true if the network has at least one active connection. It is equivalent to getNumberOfConnections() > 0.

Returns:

true if there are active connections in the network, and false otherwise

Since:

0.2.0

hasConnectionRoutes

public boolean hasConnectionRoutes()

Returns true if the network has at least one active connection. It is equivalent to getNumberOfConnectionRoutes() > 0.

Returns:

true if there are active connections in the network, and false otherwise

Since:

0.2.3

isActiveConnection

public boolean isActiveConnection(long connId)

Returns true if the given connection is active.

Parameters:

connId - Connection identifier

Returns:

true if the given connection is active, false otherwise

Since:

0.2.0

isActiveConnectionRoute

public boolean isActiveConnectionRoute(long connRoute)

Returns true if the given connection route is active.

Parameters:

connRoute - Connection route identifier

Returns:

true if the given connection route is active, false otherwise

Since:

0.2.3

update

public java.lang.Object update(SimEvent event,
                      java.util.List actions)

Update the network state.

Parameters:

event - Current simulation event

actions - List of actions to perform

Returns:

Identifier of the new connection, in case event is a connection request, and this connection is accepted; otherwise, -1

Since:

0.2.0

reset

public void reset()

Resets the state of the network.

Since:

0.2.0