ConnectionNetState (Net2Plan API)

Object
- com.net2plan.interfaces.cacSimulation.ConnectionNetState

```
public class ConnectionNetState
extends Object
```
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.

Constructors
Constructor and Description
`ConnectionNetState(NetPlan netPlan)` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`NetPlan`	`convertToNetPlan()` Converts the current network state to a network plan.
`ConnectionNetState`	`copy()` Returns a deep copy of the network state
`double`	`getConnectionArrivalTime(int connectionId)` Returns the arrival time of the specified connection.
`double`	`getConnectionCurrentTrafficInErlangs(int connectionId)` Returns the current traffic volume for a given connection.
`double[]`	`getConnectionCurrentTrafficInErlangsVector()` Returns a vector with the carried traffic per connection.
`int`	`getConnectionDemand(int connectionId)` Returns the demand identifier for a given connection.
`double`	`getConnectionDuration(int connectionId)` Returns the duration of the specified connection.
`int[]`	`getConnectionIds()` Returns the set of active connection identifiers.
`double`	`getConnectionRequestedTrafficInErlangs(int connectionId)` Returns the requested traffic volume for a given connection.
`double[]`	`getConnectionRequestedTrafficInErlangsVector()` Returns a vector with the requested traffic per connection.
`int`	`getConnectionRoute(int connectionId)` Returns the route identifier associated to the connection.
`int[]`	`getConnectionSequenceOfLinks(int connectionId)` Returns the list of links traversed by the connection.
`int[]`	`getDemandConnections(int demandId)` Returns the set of connection ids associated to a given demand.
`double[]`	`getDemandCurrentCarriedTrafficInErlangsVector()` Returns a vector with the carried traffic per demand.
`double[]`	`getDemandCurrentOfferedTrafficInErlangsVector()` Returns a vector with the offered traffic per demand.
`int[]`	`getDemandNumberOfConnectionsVector()` Returns the number of current active connections per each demand.
`double[]`	`getLinkCurrentCarriedTrafficInErlangsVector()` Returns a vector with the carried traffic per link.
`int[]`	`getLinkNumberOfTraversingConnectionsVector()` Returns the number of current traversing connections per each link.
`double[]`	`getLinkSpareCapacityInErlangsVector()` Returns a vector with the spare capacity per link.
`int[]`	`getLinkTraversingConnections(int linkId)` Returns the list of connections which are traversed by a given link.
`double[]`	`getNodeEgressTrafficInErlangsVector()` Returns the current egress traffic from each node.
`double[]`	`getNodeIngressTrafficInErlangsVector()` Returns the current ingress traffic to each node.
`double[]`	`getNodeTraversingTrafficInErlangsVector()` Returns the current traffic traversing each node.
`int`	`getNumberOfActiveConnections()` Returns the number of active connections in the network.
`boolean`	`hasConnections()` Returns `true` if the network has at least one active connection.
`boolean`	`isActiveConnection(int connId)` Returns `true` if the given connection is active.
`void`	`removeConnection(int connectionId)` Removes the connection given by the identifier
`void`	`setConnectionState(int connectionId, double currentTrafficVolume, int[] sequenceOfLinks)` Modifies the state of the specified connection.
`ConnectionNetState`	`unmodifiableView()` Returns an unmodifiable view of the network state.
`int`	`update(CACEvent event, List<CACAction> actions)` Updates the current network state according to an event and its corresponding actions.

Methods inherited from class Object
clone, equals, finalize, 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
  - isActiveConnection
```
public boolean isActiveConnection(int 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
  - setConnectionState
```
public void setConnectionState(int connectionId,
                      double currentTrafficVolume,
                      int[] sequenceOfLinks)
```
    Modifies the state of the specified connection.
    
    Parameters:
    connectionId - Connection identifier
    currentTrafficVolume - New carried traffic by this connection measured in Erlangs. It must be greater or equal than zero
    sequenceOfLinks - New sequence of links for this connection
    
    Throws:
    
    UnsupportedOperationException - If network state is not modifiable
    Since:
    
    0.2.0
  - update
```
public int update(CACEvent event,
         List<CACAction> actions)
```
    Updates the current network state according to an event and its corresponding actions.
    
    Parameters:
    event - CAC event (connection request or release)
    actions - Actions (accept/block request, modify connection, release connection)
    
    Returns:
    -1 for release events and blocked requests, connection identifier for accepted requests
    
    Throws:
    
    UnsupportedOperationException - If network state is not modifiable
    Since:
    
    0.2.0
  - copy
```
public ConnectionNetState copy()
```
    Returns a deep copy of the network state
    
    Returns:
    A deep copy of the network state
    Since:
    
    0.2.0
  - unmodifiableView
```
public ConnectionNetState unmodifiableView()
```
    Returns an unmodifiable view of the network state.
    
    Returns:
    An unmodifiable view of the network state
    Since:
    
    0.2.0
  - getConnectionCurrentTrafficInErlangsVector
```
public double[] getConnectionCurrentTrafficInErlangsVector()
```
    Returns a vector with the carried traffic per connection.
    
    Returns:
    Vector with the carried traffic per connection
    Since:
    
    0.2.0
  - getConnectionRequestedTrafficInErlangsVector
```
public double[] getConnectionRequestedTrafficInErlangsVector()
```
    Returns a vector with the requested traffic per connection.
    
    Returns:
    Vector with the requested traffic per connection
    Since:
    
    0.2.0
  - getLinkTraversingConnections
```
public int[] getLinkTraversingConnections(int linkId)
```
    Returns the list of connections which are traversed by a given link.
    
    Parameters:
    linkId - Link identifier
    
    Returns:
    List of connections traversed by the link
    Since:
    
    0.2.0
  - getLinkNumberOfTraversingConnectionsVector
```
public int[] getLinkNumberOfTraversingConnectionsVector()
```
    Returns the number of current traversing connections per each link.
    
    Returns:
    Number of current traversing connections per each link
    Since:
    
    0.2.2
  - hasConnections
```
public boolean hasConnections()
```
    Returns true if the network has at least one active connection. It is equivalent to getNumberOfActiveConnections() > 0.
    
    Returns:
    true if there are active connections in the network, and false otherwise
    Since:
    
    0.2.0
  - removeConnection
```
public void removeConnection(int connectionId)
```
    Removes the connection given by the identifier
    
    Parameters:
    connectionId - Connection identifier
    
    Throws:
    
    UnsupportedOperationException - If network state is not modifiable
    Since:
    
    0.2.0
  - getConnectionSequenceOfLinks
```
public int[] getConnectionSequenceOfLinks(int connectionId)
```
    Returns the list of links traversed by the connection.
    
    Parameters:
    connectionId - Connection identifier
    
    Returns:
    List of links and segments traversed by the connection
    Since:
    
    0.2.0
  - getNodeEgressTrafficInErlangsVector
```
public double[] getNodeEgressTrafficInErlangsVector()
```
    Returns the current egress traffic from each node.
    
    Returns:
    Current egress traffic from each node
    Since:
    
    0.2.0
  - getNodeIngressTrafficInErlangsVector
```
public double[] getNodeIngressTrafficInErlangsVector()
```
    Returns the current ingress traffic to each node.
    
    Returns:
    Current ingress traffic to each node
    Since:
    
    0.2.0
  - getNodeTraversingTrafficInErlangsVector
```
public double[] getNodeTraversingTrafficInErlangsVector()
```
    Returns the current traffic traversing each node.
    
    Returns:
    Current traffic traversing each node
    Since:
    
    0.2.0
  - getConnectionDemand
```
public int getConnectionDemand(int connectionId)
```
    Returns the demand identifier for a given connection.
    
    Parameters:
    connectionId - Connection identifier
    
    Returns:
    Demand identifier
    Since:
    
    0.2.0
  - getConnectionIds
```
public int[] getConnectionIds()
```
    Returns the set of active connection identifiers.
    
    Returns:
    Active connection identifiers
    Since:
    
    0.2.0
  - getDemandConnections
```
public int[] getDemandConnections(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
  - getDemandNumberOfConnectionsVector
```
public int[] getDemandNumberOfConnectionsVector()
```
    Returns the number of current active connections per each demand.
    
    Returns:
    Number of current active connections per each demand
    Since:
    
    0.2.2
  - 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
  - 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
  - getConnectionCurrentTrafficInErlangs
```
public double getConnectionCurrentTrafficInErlangs(int connectionId)
```
    Returns the current traffic volume for a given connection.
    
    Parameters:
    connectionId - Connection identifier
    
    Returns:
    Current traffic volume
    Since:
    
    0.2.0
  - getConnectionRequestedTrafficInErlangs
```
public double getConnectionRequestedTrafficInErlangs(int connectionId)
```
    Returns the requested traffic volume for a given connection.
    
    Parameters:
    connectionId - Connection identifier
    
    Returns:
    Requested traffic volume
    Since:
    
    0.2.0
  - getConnectionRoute
```
public int getConnectionRoute(int connectionId)
```
    Returns the route identifier associated to the connection. This value is only an indicator which can be used by user, since is actually not checked at all.
    
    Parameters:
    connectionId - Connection identifier
    
    Returns:
    Route identifier
    Since:
    
    0.2.0
  - convertToNetPlan
```
public NetPlan convertToNetPlan()
```
    Converts the current network state to a network plan. By doing so this network plan can be used for reports.
    
    Returns:
    Network plan associated to the current network state
    Since:
    
    0.2.0
  - getLinkSpareCapacityInErlangsVector
```
public double[] getLinkSpareCapacityInErlangsVector()
```
    Returns a vector with the spare capacity per link.
    
    Returns:
    Vector with the spare capacity per link
    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
  - getNumberOfActiveConnections
```
public int getNumberOfActiveConnections()
```
    Returns the number of active connections in the network.
    
    Returns:
    Number of active connections
    Since:
    
    0.2.0
  - getConnectionArrivalTime
```
public double getConnectionArrivalTime(int connectionId)
```
    Returns the arrival time of the specified connection.
    
    Parameters:
    connectionId - Connection identifier
    
    Returns:
    Arrival time
    Since:
    
    0.2.0
  - getConnectionDuration
```
public double getConnectionDuration(int connectionId)
```
    Returns the duration of the specified connection.
    
    Parameters:
    connectionId - Connection identifier
    
    Returns:
    Duration
    Since:
    
    0.2.0

Class ConnectionNetState

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

ConnectionNetState

Method Detail

isActiveConnection

setConnectionState

update

copy

unmodifiableView

getConnectionCurrentTrafficInErlangsVector

getConnectionRequestedTrafficInErlangsVector

getLinkTraversingConnections

getLinkNumberOfTraversingConnectionsVector

hasConnections

removeConnection

getConnectionSequenceOfLinks

getNodeEgressTrafficInErlangsVector

getNodeIngressTrafficInErlangsVector

getNodeTraversingTrafficInErlangsVector

getConnectionDemand

getConnectionIds

getDemandConnections

getDemandNumberOfConnectionsVector

getDemandCurrentOfferedTrafficInErlangsVector

getDemandCurrentCarriedTrafficInErlangsVector

getConnectionCurrentTrafficInErlangs

getConnectionRequestedTrafficInErlangs

getConnectionRoute

convertToNetPlan

getLinkSpareCapacityInErlangsVector

getLinkCurrentCarriedTrafficInErlangsVector

getNumberOfActiveConnections

getConnectionArrivalTime

getConnectionDuration