com.net2plan.interfaces.resilienceSimulation

Class ResilienceNetState

java.lang.Object

SimState

com.net2plan.interfaces.resilienceSimulation.ResilienceNetState

public final class ResilienceNetState
extends SimState

Represents the current state of a network within the resilience simulation: SRGs/nodes/links up/down, current carried 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 (ResilienceEvent) scheduled by the event generator (see IResilienceEventGenerator) and the actions (see ProvisioningAction) provided by the event processor (see IProvisioningAlgorithm).

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Constructor Summary

Constructors

Constructor and Description
ResilienceNetState(NetPlan netPlan) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkProtectionSegmentMergeabilityToRoute(long routeId, long segmentId) Tests whether a given protection segment is applicable to a route.
void	checkRouteValidityForDemand(long[] sequenceOfLinksAndSegments, int demandId) Checks if a sequence of links is valid for a given demand.
void	checkValidity(java.util.Map<java.lang.String,java.lang.String> net2planParameters, boolean allowLinkOversubscription, boolean allowExcessCarriedTraffic)
int[]	convertBackupRoute2SequenceOfLinks(long[] seqLinksAndSegments) Converts a sequence of links and segments to a sequence of links.
NetPlan	convertToNetPlan() Returns a network design from the current network state.
SimState	copy() Returns a deep copy of the current state.
double[]	getDemandCurrentCarriedTrafficInErlangsVector() Returns the current carried traffic per demand.
long[]	getDemandRoutes(int demandId) Returns the routes carrying traffic for a given demand.
void	getFailureEffects(ResilienceEvent event, java.util.Set<java.lang.Integer> nodesDown, java.util.Set<java.lang.Integer> linksDown, java.util.Set<java.lang.Long> affectedRoutes, java.util.Set<java.lang.Long> unrecoverableRoutes, java.util.List<java.lang.Double> currentLinkAvailableCapacity, java.util.Map<java.lang.Long,java.lang.Double> availableSegments) Returns the effects of a failure event.
int	getFirstAvailableNodeDownstream(long routeId, int[] nodesDown, int[] linksDown) Returns the first node available from the failure point to the egress node for a given route.
int	getFirstAvailableNodeUpstream(long routeId, int[] nodesDown, int[] linksDown) Returns the first node available before the failure point for a given route.
double[]	getLinkCurrentCarriedTrafficInErlangsVector() Returns the current carried traffic per link.
long[]	getLinkCurrentTraversingProtectionSegments(int linkId) Returns the set of protection segments traversing a given link.
long[][]	getLinkCurrentTraversingProtectionSegmentsVector() Returns the set of protection segments traversing each link.
int[]	getLinksDown() Returns the list of links which are down.
int[]	getLinksOversubscribed() Returns the set of over-subscribed links.
long[]	getLinkTraversingCurrentRoutes(int linkId) Returns the routes traversing a given link in their current path.
long[]	getLinkTraversingPrimaryRoutes(int linkId) Returns the routes traversing a given link in their primary path.
long[]	getMergedBackupRoute(long[] currentPath, long segmentId) Returns the new route resulting from applying a protection segment.
int[]	getMergedRoute(int[] originalRoute, int[] partialRoute) Returns a modified route resulting after applying a partial segment to the original route.
long	getNextProtectionSegmentId() Returns the identifier of the next added protection segment.
long	getNextRouteId() Returns the identifier of the next added route.
double[][]	getNodeCurrentTrafficInErlangsVector() Returns the current ingress/egress/traversing traffic to each node.
void	getNodeLinkStateChanges(int[] newSRGsDown, int[] newSRGsUp, java.util.Set<java.lang.Integer> nodesDown2Up, java.util.Set<java.lang.Integer> nodesUp2Down, java.util.Set<java.lang.Integer> linksDown2Up, java.util.Set<java.lang.Integer> linksUp2Down) Returns the set of current state changes in the network.
double[][]	getNodePrimaryTrafficInErlangsVector() Returns the planned ingress/egress/traversing traffic to each node.
int[]	getNodesDown() Returns the list of nodes which are down.
java.lang.String	getProtectionSegmentAttribute(long segmentId, java.lang.String key) Returns the value of a given attribute for a protection segment.
double	getProtectionSegmentCurrentCarriedTrafficInErlangs(long segmentId) Returns the current carried traffic of the given protection segment.
int	getProtectionSegmentDestinationNode(long segmentId) Returns the destination node of a given protection segment.
long[]	getProtectionSegmentIds() Returns the identifiers of the current protection segments.
int	getProtectionSegmentOriginNode(long segmentId) Returns the origin node of a given protection segment.
double	getProtectionSegmentReservedBandwidthInErlangs(long segmentId) Returns the reserved bandwidth for a given protection segment.
int[]	getProtectionSegmentSequenceOfLinks(long segmentId) Returns the sequence of links of a given protection segment.
java.util.Map<java.lang.String,java.lang.String>	getProtectionSegmentSpecificAttributes(long segmentId) Returns the specific attributes of a given protection segment.
void	getReparationEffects(ResilienceEvent event, java.util.Set<java.lang.Integer> nodesDown, java.util.Set<java.lang.Integer> linksDown, java.util.Set<java.lang.Long> reparableRoutes, java.util.Set<java.lang.Long> unreparableRoutes, java.util.List<java.lang.Double> currentLinkAvailableCapacity, java.util.Map<java.lang.Long,java.lang.Double> availableSegments) Returns the effects of a reparation event.
java.lang.String	getRouteAttribute(long routeId, java.lang.String key) Returns the value of a given attribute for a route.
long[]	getRouteBackupSegmentList(long routeId) Returns the backup protection segments associated to a given route.
double	getRouteCurrentCarriedTrafficVolumeInErlangs(long routeId)
long[]	getRouteCurrentSequenceOfLinksAndSegments(long routeId) Returns the current sequence of links and segments of a given route.
int	getRouteDemand(long routeId) Returns the demand associated to a given route.
long[]	getRouteIds() Returns the identifiers of the current routes.
double	getRoutePrimaryPathCarriedTrafficVolumeInErlangs(long routeId) Returns the carried traffic in the primary path for a given route.
int[]	getRoutePrimaryPathSequenceOfLinks(long routeId) Returns the sequence of links of a given route in its primary path.
int[]	getRoutePriorityVector(long[] routeIds) Indicates the priority of each of the given routes (default, 0).
java.util.Map<java.lang.String,java.lang.String>	getRouteSpecificAttributes(long routeId) Returns the attributes for a given route.
long[]	getSRGRoutesCurrentPath(int srgId) Returns the routes traversing elements in a given SRG in their current path.
long[]	getSRGRoutesPrimaryPath(int srgId) Returns the routes traversing elements in a given SRG in their primary path.
int[]	getSRGsDown() Returns the set of SRGs which are down.
boolean	hasProtectionSegments() Indicates whether or not there are active protection segments.
boolean	hasRoutes() Indicates whether or not there are active routes.
boolean	isRoutePartialRecoveryAllowed(long routeId) Indicates whether or not a given route allows partial recovery (default, true).
boolean	isRouteRevertible(long routeId) Indicates whether or not a given route is revertible (default, true).
void	reset() Resets the state of the network.
SimState	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

ResilienceNetState

public ResilienceNetState(NetPlan netPlan)

Default constructor. Initializes the network state using existing information (SRGs, routes and protection segments).

Parameters:

netPlan - Initial network design

Since:

0.2.0

Method Detail

getLinkCurrentCarriedTrafficInErlangsVector

public double[] getLinkCurrentCarriedTrafficInErlangsVector()

Returns the current carried traffic per link. The carried traffic is equal to the sum of the traffic of each route traversing the link, except for protection segments.

Returns:

Current carried traffic per link (in Erlangs)

Since:

0.2.3

getLinksOversubscribed

public int[] getLinksOversubscribed()

Returns the set of over-subscribed links. A link is said to be over-subscribed when its carried traffic (sum of carried traffic for primary paths, reserved bandwidth for protection, and used capacity for restoration) is greater than the capacity.

Returns:

Set of over-subscribed links

Since:

0.2.3

getProtectionSegmentCurrentCarriedTrafficInErlangs

public double getProtectionSegmentCurrentCarriedTrafficInErlangs(long segmentId)

Returns the current carried traffic of the given protection segment.

Parameters:

segmentId - Segment identifier

Returns:

Current traffic volume (in Erlangs)

Since:

0.2.3

checkValidity

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

convertToNetPlan

public NetPlan convertToNetPlan()

Returns a network design from the current network state.

Returns:

Network design

Since:

0.2.0

getDemandCurrentCarriedTrafficInErlangsVector

public double[] getDemandCurrentCarriedTrafficInErlangsVector()

Returns the current carried traffic per demand.

Returns:

Current carried traffic per demand (in Erlangs)

Since:

0.2.3

getDemandRoutes

public long[] getDemandRoutes(int demandId)

Returns the routes carrying traffic for a given demand.

Parameters:

demandId - Demand identifier

Returns:

Route identifiers

Since:

0.2.3

checkRouteValidityForDemand

public void checkRouteValidityForDemand(long[] sequenceOfLinksAndSegments,
                               int demandId)

Checks if a sequence of links is valid for a given demand.

Parameters:

demandId - Demand identifier

sequenceOfLinksAndSegments - Sequence of links and segments

Since:

0.2.3

getMergedBackupRoute

public long[] getMergedBackupRoute(long[] currentPath,
                          long segmentId)

Returns the new route resulting from applying a protection segment.

Parameters:

currentPath - Current sequence of links

segmentId - Protection segment identifier

Returns:

New sequence of links

Since:

0.2.3

getProtectionSegmentOriginNode

public int getProtectionSegmentOriginNode(long segmentId)

Returns the origin node of a given protection segment.

Parameters:

segmentId - Segment identifier

Returns:

Node identifier

Since:

0.2.3

getProtectionSegmentDestinationNode

public int getProtectionSegmentDestinationNode(long segmentId)

Returns the destination node of a given protection segment.

Parameters:

segmentId - Segment identifier

Returns:

Node identifier

Since:

0.2.3

getFailureEffects

public void getFailureEffects(ResilienceEvent event,
                     java.util.Set<java.lang.Integer> nodesDown,
                     java.util.Set<java.lang.Integer> linksDown,
                     java.util.Set<java.lang.Long> affectedRoutes,
                     java.util.Set<java.lang.Long> unrecoverableRoutes,
                     java.util.List<java.lang.Double> currentLinkAvailableCapacity,
                     java.util.Map<java.lang.Long,java.lang.Double> availableSegments)

Returns the effects of a failure event.

Parameters:

event - Node/link failure event

nodesDown - Set of nodes which are down

linksDown - Set of links which are down

affectedRoutes - Routes which are going down and might be rerouted

unrecoverableRoutes - Routes which are going down but cannot be rerouted (ingress/egress node is down)

currentLinkAvailableCapacity - Current available capacity per link (for links in down state it is equal to zero)

availableSegments - Set of protection segments which are up and their corresponding available capacity

Since:

0.2.0

getFirstAvailableNodeDownstream

public int getFirstAvailableNodeDownstream(long routeId,
                                  int[] nodesDown,
                                  int[] linksDown)

Returns the first node available from the failure point to the egress node for a given route.

Parameters:

routeId - Route identifier

nodesDown - Set of nodes which are currently down

linksDown - Set of links which are currently down

Returns:

Node identifier (or -1, if no node is available after the failure point)

Since:

0.2.0

getFirstAvailableNodeUpstream

public int getFirstAvailableNodeUpstream(long routeId,
                                int[] nodesDown,
                                int[] linksDown)

Returns the first node available before the failure point for a given route.

Parameters:

routeId - Route identifier

nodesDown - Set of nodes which are currently down

linksDown - Set of links which are currently down

Returns:

Node identifier (or -1, if no node is available after the failure point)

Since:

0.2.0

getLinkCurrentTraversingProtectionSegments

public long[] getLinkCurrentTraversingProtectionSegments(int linkId)

Returns the set of protection segments traversing a given link.

Parameters:

linkId - Link identifier

Returns:

Protection segment identifiers

Since:

0.2.3

getLinkCurrentTraversingProtectionSegmentsVector

public long[][] getLinkCurrentTraversingProtectionSegmentsVector()

Returns the set of protection segments traversing each link.

Returns:

Protection segment identifiers per link

Since:

0.2.3

getLinksDown

public int[] getLinksDown()

Returns the list of links which are down.

Returns:

List of links in state down

Since:

0.2.0

getNextProtectionSegmentId

public long getNextProtectionSegmentId()

Returns the identifier of the next added protection segment.

Returns:

Protection segment identifier

Since:

0.2.3

getNextRouteId

public long getNextRouteId()

Returns the identifier of the next added route.

Returns:

Route identifier

Since:

0.2.3

getNodeLinkStateChanges

public void getNodeLinkStateChanges(int[] newSRGsDown,
                           int[] newSRGsUp,
                           java.util.Set<java.lang.Integer> nodesDown2Up,
                           java.util.Set<java.lang.Integer> nodesUp2Down,
                           java.util.Set<java.lang.Integer> linksDown2Up,
                           java.util.Set<java.lang.Integer> linksUp2Down)

Returns the set of current state changes in the network.

Parameters:

newSRGsDown - Set of failure groups which are moving from up to down

newSRGsUp - Set of failure groups which are moving from down to up

nodesDown2Up - Set of nodes changing from down to up

nodesUp2Down - Set of nodes changing from up to down

linksDown2Up - Set of links changing from down to up

linksUp2Down - Set of links changing from up to down

Since:

0.2.0

getNodesDown

public int[] getNodesDown()

Returns the list of nodes which are down.

Returns:

List of nodes in state down

Since:

0.2.0

getProtectionSegmentReservedBandwidthInErlangs

public double getProtectionSegmentReservedBandwidthInErlangs(long segmentId)

Returns the reserved bandwidth for a given protection segment.

Parameters:

segmentId - Segment identifier

Returns:

Reserved bandwidth (in Erlangs)

Since:

0.2.3

getProtectionSegmentSequenceOfLinks

public int[] getProtectionSegmentSequenceOfLinks(long segmentId)

Returns the sequence of links of a given protection segment.

Parameters:

segmentId - Segment identifier

Returns:

Sequence of links

Since:

0.2.3

getProtectionSegmentIds

public long[] getProtectionSegmentIds()

Returns the identifiers of the current protection segments. Identifiers are sorted in ascending order.

Returns:

Identifiers of the current protection segments

Since:

0.2.3

getProtectionSegmentSpecificAttributes

public java.util.Map<java.lang.String,java.lang.String> getProtectionSegmentSpecificAttributes(long segmentId)

Returns the specific attributes of a given protection segment.

Parameters:

segmentId - Protection segment identifier

Returns:

Protection segment attributes

Since:

0.2.3

getReparationEffects

public void getReparationEffects(ResilienceEvent event,
                        java.util.Set<java.lang.Integer> nodesDown,
                        java.util.Set<java.lang.Integer> linksDown,
                        java.util.Set<java.lang.Long> reparableRoutes,
                        java.util.Set<java.lang.Long> unreparableRoutes,
                        java.util.List<java.lang.Double> currentLinkAvailableCapacity,
                        java.util.Map<java.lang.Long,java.lang.Double> availableSegments)

Returns the effects of a reparation event.

Parameters:

event - Node/link reparation event

nodesDown - Set of nodes which are down

linksDown - Set of links which are down

reparableRoutes - Routes using a backup path whose (planned) primary path is available

unreparableRoutes - Routes using a backup path whose (planned) primary path is not available

currentLinkAvailableCapacity - Current available capacity per link (for links in down state it is equal to zero)

availableSegments - Set of protection segments which are up and their corresponding available capacity

Since:

0.2.0

getMergedRoute

public int[] getMergedRoute(int[] originalRoute,
                   int[] partialRoute)

Returns a modified route resulting after applying a partial segment to the original route.

Parameters:

originalRoute - Sequence of links of the original route

partialRoute - Sequence of links of the partial segment

Returns:

New sequence of links

Since:

0.2.3

getRouteAttribute

public java.lang.String getRouteAttribute(long routeId,
                                 java.lang.String key)

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

Parameters:

routeId - Route identifier

key - Attribute name

Returns:

Attribute value (or null, if not defined)

Since:

0.2.3

getProtectionSegmentAttribute

public java.lang.String getProtectionSegmentAttribute(long segmentId,
                                             java.lang.String key)

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

Parameters:

segmentId - Protection segment identifier

key - Attribute name

Returns:

Attribute value (or null, if not defined)

Since:

0.2.3

getRouteBackupSegmentList

public long[] getRouteBackupSegmentList(long routeId)

Returns the backup protection segments associated to a given route.

Parameters:

routeId - Route identifier

Returns:

Protection segment identifiers

Since:

0.2.3

getRouteCurrentCarriedTrafficVolumeInErlangs

public double getRouteCurrentCarriedTrafficVolumeInErlangs(long routeId)

Parameters:

routeId - Route identifier

Returns:

Since:

0.2.3

getRouteCurrentSequenceOfLinksAndSegments

public long[] getRouteCurrentSequenceOfLinksAndSegments(long routeId)

Returns the current sequence of links and segments of a given route.

Parameters:

routeId - Route identifier

Returns:

Current sequence of links and segments. Segment identifiers are represented as -1-segmentId.

Since:

0.2.3

getRouteDemand

public int getRouteDemand(long routeId)

Returns the demand associated to a given route.

Parameters:

routeId - Route identifier

Returns:

Demand identifier

Since:

0.2.3

getRouteIds

public long[] getRouteIds()

Returns the identifiers of the current routes. Identifiers are sorted in ascending order.

Returns:

Identifiers of the current routes

Since:

0.2.3

getRoutePrimaryPathCarriedTrafficVolumeInErlangs

public double getRoutePrimaryPathCarriedTrafficVolumeInErlangs(long routeId)

Returns the carried traffic in the primary path for a given route.

Parameters:

routeId - Route identifier

Returns:

Traffic volume (in Erlangs)

Since:

0.2.3

getRoutePrimaryPathSequenceOfLinks

public int[] getRoutePrimaryPathSequenceOfLinks(long routeId)

Returns the sequence of links of a given route in its primary path.

Parameters:

routeId - Route identifier

Returns:

Sequence of links

Since:

0.2.3

getRouteSpecificAttributes

public java.util.Map<java.lang.String,java.lang.String> getRouteSpecificAttributes(long routeId)

Returns the attributes for a given route.

Parameters:

routeId - Route identifier

Returns:

Attributes

Since:

0.2.3

getSRGRoutesPrimaryPath

public long[] getSRGRoutesPrimaryPath(int srgId)

Returns the routes traversing elements in a given SRG in their primary path.

Parameters:

srgId - SRG identifier

Returns:

Route identifiers

Since:

0.2.3

getSRGRoutesCurrentPath

public long[] getSRGRoutesCurrentPath(int srgId)

Returns the routes traversing elements in a given SRG in their current path.

Parameters:

srgId - SRG identifier

Returns:

Route identifiers

Since:

0.2.3

convertBackupRoute2SequenceOfLinks

public int[] convertBackupRoute2SequenceOfLinks(long[] seqLinksAndSegments)

Converts a sequence of links and segments to a sequence of links.

Parameters:

seqLinksAndSegments - Sequence of links and segments

Returns:

Sequence of links

Since:

0.2.3

getSRGsDown

public int[] getSRGsDown()

Returns the set of SRGs which are down.

Returns:

SRGs down

Since:

0.2.0

hasProtectionSegments

public boolean hasProtectionSegments()

Indicates whether or not there are active protection segments.

Returns:

true if there are active protection segments. Otherwise, false

Since:

0.2.3

hasRoutes

public boolean hasRoutes()

Indicates whether or not there are active routes.

Returns:

true if there are active routes. Otherwise, false

Since:

0.2.3

getRoutePriorityVector

public int[] getRoutePriorityVector(long[] routeIds)

Indicates the priority of each of the given routes (default, 0).

Parameters:

routeIds - Route identifiers

Returns:

Priority vector

Since:

0.2.3

isRoutePartialRecoveryAllowed

public boolean isRoutePartialRecoveryAllowed(long routeId)

Indicates whether or not a given route allows partial recovery (default, true).

Parameters:

routeId - Route identifier

Returns:

true if route allows partial recovery. Otherwise, false

Since:

0.2.3

isRouteRevertible

public boolean isRouteRevertible(long routeId)

Indicates whether or not a given route is revertible (default, true).

Parameters:

routeId - Route identifier

Returns:

true if route is revertible. Otherwise, false

Since:

0.2.3

reset

public void reset()

Resets the state of the network.

Since:

0.2.0

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:

A null object

Since:

0.2.0

checkProtectionSegmentMergeabilityToRoute

public boolean checkProtectionSegmentMergeabilityToRoute(long routeId,
                                                long segmentId)

Tests whether a given protection segment is applicable to a route. A protection segment is applicable is contained within the route.

Parameters:

segmentId - Segment identifier

routeId - Route identifier

Returns:

true is segment is applicable to route, false otherwise

Since:

0.2.3

copy

public SimState copy()

Returns a deep copy of the current state.

Returns:

Deep copy of the current state

Since:

0.2.0

unmodifiableView

public SimState unmodifiableView()

Returns an unmodifiable view of the network.

Returns:

An unmodifiable view of the network

Since:

0.2.0

getNodePrimaryTrafficInErlangsVector

public double[][] getNodePrimaryTrafficInErlangsVector()

Returns the planned ingress/egress/traversing traffic to each node.

Returns:

Planned ingress/egress/traversing per node. Each row represents a node, whereas each column represents ingress, egress and traversing traffic, respectively

Since:

0.2.3

getNodeCurrentTrafficInErlangsVector

public double[][] getNodeCurrentTrafficInErlangsVector()

Returns the current ingress/egress/traversing traffic to each node.

Returns:

Current ingress/egress/traversing per node. Each row represents a node, whereas each column represents ingress, egress and traversing traffic, respectively

Since:

0.2.3

getLinkTraversingCurrentRoutes

public long[] getLinkTraversingCurrentRoutes(int linkId)

Returns the routes traversing a given link in their current path.

Parameters:

linkId - Link identifier

Returns:

Route identifiers

Since:

0.2.3

getLinkTraversingPrimaryRoutes

public long[] getLinkTraversingPrimaryRoutes(int linkId)

Returns the routes traversing a given link in their primary path.

Parameters:

linkId - Link identifier

Returns:

Route identifiers

Since:

0.2.3