com.net2plan.interfaces.resilienceSimulation

Class ResilienceNetState

Object

com.net2plan.interfaces.resilienceSimulation.ResilienceNetState

public class ResilienceNetState
extends Object

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
void	check(Map<String,String> net2planParameters) Checks the current network state.
NetPlan	convertToNetPlan() Converts the current network state to a network plan.
ResilienceNetState	copy() Returns a deep copy of the network state
double[]	getDemandCarriedTrafficInErlangsVector() Returns the current carried traffic per demand.
void	getFailureEffects(ResilienceEvent event, Set<Integer> nodesDown, Set<Integer> linksDown, Set<Integer> affectedRoutes, Set<Integer> unrecoverableRoutes, List<Double> currentLinkAvailableCapacity, Set<Integer> segmentsDown, List<Double> currentSegmentAvailableCapacity)
double[]	getFailureGroupMTTFVector() Returns the mean time to fail per each SRG.
double[]	getFailureGroupMTTRVector() Returns the mean time to repair per each SRG.
int[]	getFailureGroupsDown()
int[]	getFailureStateLinks(int srgId) Returns the links associated to a given SRG.
int[]	getFailureStateNodes(int srgId) Returns the nodes associated to a given SRG.
int	getFirstAvailableNodeDownstream(int routeId, int[] nodesDown, int[] linksDown) Returns the first node available from the failure point to the egress node for a given route.
int	getFirstAvailableNodeUpstream(int routeId, int[] nodesDown, int[] linksDown) Returns the first node available before the failure point for a given route.
double	getLinkAvailableCapacityInErlangs(int linkId, int[] linksDown)
double[]	getLinkAvailableCapacityInErlangsVector(int[] linksDown)
double	getLinkCurrentCarriedTrafficInErlangs(int linkId) Returns the carried traffic by the specified link.
double[]	getLinkCurrentCarriedTrafficInErlangsVector() Returns a vector with the carried traffic per link.
int[]	getLinksDown() Returns the list of links which are down.
int[]	getLinkTraversingRoutes(int linkId) Returns the list of routes 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.
void	getNodeLinkStateChanges(int[] newSRGsDown, int[] newSRGsUp, Set<Integer> nodesDown2Up, Set<Integer> nodesUp2Down, Set<Integer> linksDown2Up, Set<Integer> linksUp2Down) Returns the set of current state changes in the network.
int[]	getNodesDown() Returns the list of nodes which are down.
int[]	getNodeTraversingRoutes(int nodeId) Returns the current routes traversing a given node.
double[]	getNodeTraversingTrafficInErlangsVector() Returns the current traffic traversing each node.
int	getNumberOfFailureGroups() Returns the number of defined SRGs.
double[]	getProtectionSegmentAvailableCapacityInErlangsVector(int[] segmentsDown) Returns the available capacity at each protection segment.
double	getProtectionSegmentCurrentCarriedTrafficInErlangs(int segmentId) Returns the traffic carried by the specified protection segment.
double[]	getProtectionSegmentCurrentCarriedTrafficInErlangsVector() Returns a vector with the carried traffic per protection segment.
int[]	getProtectionSegmentsDown(int[] nodesDown, int[] linksDown) Returns the list of protection segments which are down.
void	getReparationEffects(ResilienceEvent event, Set<Integer> nodesDown, Set<Integer> linksDown, Set<Integer> reparableRoutes, Set<Integer> unreparableRoutes, List<Double> currentLinkAvailableCapacity, Set<Integer> segmentsDown, List<Double> currentSegmentAvailableCapacity)
double	getRouteCurrentCarriedTrafficInErlangs(int routeId) Returns the current carried traffic by a route.
double[]	getRouteCurrentCarriedTrafficInErlangsVector() Returns a vector with the current carried traffic by the routes.
int[]	getRouteCurrentSequenceOfLinksAndSegments(int routeId) Returns the list of links and segments traversed by the route.
int[]	getRouteCurrentSequenceOfNodes(int routeId)
void	setFailureGroups(int[][] N_f, int[][] E_f, double[] mttf, double[] mttr) Sets the defined SRGs within the network.
String	toString() Returns a String representation of the object.
ResilienceNetState	unmodifiableView() Returns an unmodifiable view of the network state.
void	update(ResilienceEvent event, List<ProvisioningAction> actions) Update the network state.

Methods inherited from class Object

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

Constructor Detail

ResilienceNetState

public ResilienceNetState(NetPlan netPlan)

Default constructor. Initializes a network state structure. It assumes that no failure groups (SRGs) are defined.

Parameters:

netPlan - Complete network design (including traffic routes)

Since:

0.2.0

Method Detail

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

copy

public ResilienceNetState copy()

Returns a deep copy of the network state

Returns:

A deep copy of the network state

Since:

0.2.0

getFailureStateNodes

public int[] getFailureStateNodes(int srgId)

Returns the nodes associated to a given SRG.

Parameters:

srgId - Shared-risk group identifier

Returns:

Nodes associated to a given SRG

Since:

0.2.2

getFailureStateLinks

public int[] getFailureStateLinks(int srgId)

Returns the links associated to a given SRG.

Parameters:

srgId - Shared-risk group identifier

Returns:

Links associated to a given SRG

Since:

0.2.0

unmodifiableView

public ResilienceNetState unmodifiableView()

Returns an unmodifiable view of the network state.

Returns:

An unmodifiable view of the network state

Since:

0.2.0

getFailureGroupMTTFVector

public double[] getFailureGroupMTTFVector()

Returns the mean time to fail per each SRG.

Returns:

MTTF for every SRG

Since:

0.2.0

getFailureGroupMTTRVector

public double[] getFailureGroupMTTRVector()

Returns the mean time to repair per each SRG.

Returns:

MTTR for every SRG

Since:

0.2.0

setFailureGroups

public void setFailureGroups(int[][] N_f,
                    int[][] E_f,
                    double[] mttf,
                    double[] mttr)

Sets the defined SRGs within the network.

Parameters:

N_f - Each row represents the nodes in a given SRG

E_f - Each row represents the links in a given SRG

mttf - Mean time to fail for each failure group

mttr - Mean time to repair for each failure group

Since:

0.2.0

getLinksDown

public int[] getLinksDown()

Returns the list of links which are down.

Returns:

List of links in state 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

getProtectionSegmentsDown

public int[] getProtectionSegmentsDown(int[] nodesDown,
                              int[] linksDown)

Returns the list of protection segments which are down.

Parameters:

nodesDown - Set of nodes which are currently down

linksDown - Set of links which are currently down

Returns:

List of protection segments in state down

Since:

0.2.0

getNodeLinkStateChanges

public void getNodeLinkStateChanges(int[] newSRGsDown,
                           int[] newSRGsUp,
                           Set<Integer> nodesDown2Up,
                           Set<Integer> nodesUp2Down,
                           Set<Integer> linksDown2Up,
                           Set<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

getFailureEffects

public void getFailureEffects(ResilienceEvent event,
                     Set<Integer> nodesDown,
                     Set<Integer> linksDown,
                     Set<Integer> affectedRoutes,
                     Set<Integer> unrecoverableRoutes,
                     List<Double> currentLinkAvailableCapacity,
                     Set<Integer> segmentsDown,
                     List<Double> currentSegmentAvailableCapacity)

Parameters:

event - Failure event

nodesDown -

linksDown -

affectedRoutes -

unrecoverableRoutes -

currentLinkAvailableCapacity -

segmentsDown -

currentSegmentAvailableCapacity -

getReparationEffects

public void getReparationEffects(ResilienceEvent event,
                        Set<Integer> nodesDown,
                        Set<Integer> linksDown,
                        Set<Integer> reparableRoutes,
                        Set<Integer> unreparableRoutes,
                        List<Double> currentLinkAvailableCapacity,
                        Set<Integer> segmentsDown,
                        List<Double> currentSegmentAvailableCapacity)

Parameters:

event -

nodesDown -

linksDown -

reparableRoutes -

unreparableRoutes -

currentLinkAvailableCapacity -

segmentsDown -

currentSegmentAvailableCapacity -

getFirstAvailableNodeDownstream

public int getFirstAvailableNodeDownstream(int 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(int 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

getNodeTraversingRoutes

public int[] getNodeTraversingRoutes(int nodeId)

Returns the current routes traversing a given node.

Parameters:

nodeId - Node identifier

Returns:

Route identifiers

Since:

0.2.0

getLinkTraversingRoutes

public final int[] getLinkTraversingRoutes(int linkId)

Returns the list of routes which are traversed by a given link.

Parameters:

linkId - Link identifier

Returns:

List of routes traversed by the link

Since:

0.2.0

getDemandCarriedTrafficInErlangsVector

public double[] getDemandCarriedTrafficInErlangsVector()

Returns the current carried traffic per demand.

Returns:

Carried traffic per demand

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

getProtectionSegmentAvailableCapacityInErlangsVector

public double[] getProtectionSegmentAvailableCapacityInErlangsVector(int[] segmentsDown)

Returns the available capacity at each protection segment.

Parameters:

segmentsDown - Set of protection segments which are down

Returns:

Available capacity per protection segment

Since:

0.2.0

getLinkAvailableCapacityInErlangs

public double getLinkAvailableCapacityInErlangs(int linkId,
                                       int[] linksDown)

Parameters:

linkId -

linksDown -

Returns:

getLinkAvailableCapacityInErlangsVector

public double[] getLinkAvailableCapacityInErlangsVector(int[] linksDown)

Parameters:

linksDown -

Returns:

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

getFailureGroupsDown

public int[] getFailureGroupsDown()

Returns:

check

public void check(Map<String,String> net2planParameters)

Checks the current network state.

Parameters:

net2planParameters - A key-value map with Net2Plan-wide configuration options

Since:

0.2.0

getLinkCurrentCarriedTrafficInErlangs

public double getLinkCurrentCarriedTrafficInErlangs(int linkId)

Returns the carried traffic by the specified link.

Parameters:

linkId - Link identifier

Returns:

The carried traffic by the specified link

Since:

0.2.0

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

getRouteCurrentCarriedTrafficInErlangs

public double getRouteCurrentCarriedTrafficInErlangs(int routeId)

Returns the current carried traffic by a route.

Parameters:

routeId - Route identifier

Returns:

Current carried traffic in Erlangs

Since:

0.2.0

getRouteCurrentCarriedTrafficInErlangsVector

public double[] getRouteCurrentCarriedTrafficInErlangsVector()

Returns a vector with the current carried traffic by the routes.

Returns:

Vector of carried traffic by routes

Since:

0.2.0

getRouteCurrentSequenceOfNodes

public int[] getRouteCurrentSequenceOfNodes(int routeId)

Parameters:

routeId -

Returns:

getRouteCurrentSequenceOfLinksAndSegments

public int[] getRouteCurrentSequenceOfLinksAndSegments(int routeId)

Returns the list of links and segments traversed by the route.

Parameters:

routeId - Route identifier

Returns:

List of links and segments traversed by the route

Since:

0.2.0

getProtectionSegmentCurrentCarriedTrafficInErlangs

public double getProtectionSegmentCurrentCarriedTrafficInErlangs(int segmentId)

Returns the traffic carried by the specified protection segment.

Parameters:

segmentId - Protection segment identifier

Returns:

Traffic carried by the specified protection segment

Since:

0.2.0

getProtectionSegmentCurrentCarriedTrafficInErlangsVector

public double[] getProtectionSegmentCurrentCarriedTrafficInErlangsVector()

Returns a vector with the carried traffic per protection segment.

Returns:

A vector with the carried traffic per protection segment

Since:

0.2.0

update

public void update(ResilienceEvent event,
          List<ProvisioningAction> actions)

Update the network state.

Parameters:

event - Failure/reparation

actions - List of action to perform

Since:

0.2.0

getNumberOfFailureGroups

public int getNumberOfFailureGroups()

Returns the number of defined SRGs.

Returns:

Number of defined SRGs

Since:

0.2.0

toString

public String toString()

Returns a String representation of the object.

Overrides:

toString in class Object

Returns:

String representation of the object

Since:

0.2.0