com.net2plan.libraries

Class WDMUtils

Object

com.net2plan.libraries.WDMUtils

public class WDMUtils
extends Object

Class to deal with optical topologies including wavelength assignment and regenerator placement.

Since:

0.2.1

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WDMUtils.WavelengthOccupancyTransformer Fiber-to-weight transformer for shortest path algorithms which returns Double.MAX_VALUE for already-occupied fibers, and the associated weight otherwise.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEQUENCE_OF_REGENERATORS_ATTRIBUTE_NAME Route/protection segment attribute name for sequence of regenerators.
static String	SEQUENCE_OF_WAVELENGTHS_ATTRIBUTE_NAME Route/protection segment attribute name for sequence of wavelengths.

Method Summary

Methods

Modifier and Type	Method and Description
static void	allocateResources(List<Long> seqFibers, int[] seqWavelengths, List<Set<Long>> wavelengthFiberOccupancy) Updates wavelengthFiberOccupancy to consider that a new lightpath is occupying a wavelength in each fiber.
static void	allocateResources(List<Long> seqFibers, int wavelengthId, List<Set<Long>> wavelengthFiberOccupancy) Updates wavelengthFiberOccupancy to consider that a new lightpath is occupying a wavelength in each fiber.
static void	allocateResources(Map<Long,Pair<Long,Long>> fiberMap, List<Long> seqFibers, int[] seqWavelengths, List<Set<Long>> wavelengthFiberOccupancy, int[] seqRegenerators, Map<Long,Integer> nodeRegeneratorOccupancy) Updates wavelengthFiberOccupancy to consider that a new lightpath is occupying a wavelength in each fiber.
static void	allocateResources(Map<Long,Pair<Long,Long>> fiberMap, List<Long> seqFibers, int wavelengthId, List<Set<Long>> wavelengthFiberOccupancy, int[] seqRegenerators, Map<Long,Integer> nodeRegeneratorOccupancy) Updates wavelengthFiberOccupancy to consider that a new lightpath is occupying a wavelength in each fiber.
static void	checkConsistency(NetPlan netPlan) Performs extra checks to those applicable to every network design, especially focused on WDM networks.
static void	checkConsistency(NetPlan netPlan, long layerId) Performs extra checks to those applicable to every network design, especially focused on WDM networks.
static int[]	computeRegeneratorPositions(Map<Long,Pair<Long,Long>> fiberMap, List<Long> seqFibers, int[] seqWavelengths, Map<Long,Double> l_f, double maxRegeneratorDistanceInKm) Returns the list of nodes within the lightpath route containing a regenerator, only following a distance criterium, assuming wavelength conversion is required.
static int[]	computeRegeneratorPositions(Map<Long,Pair<Long,Long>> fiberMap, List<Long> seqFibers, Map<Long,Double> l_f, double maxRegeneratorDistanceInKm) Returns the list of nodes within the lightpath route containing a regenerator, only following a distance criterium, assuming no wavelength conversion is required.
static int	getFiberNumWavelengths(NetPlan netPlan, long fiberId) Returns the number of wavelengths for the given fiber.
static int	getFiberNumWavelengths(NetPlan netPlan, long layerId, long fiberId) Returns the number of wavelengths for the given fiber.
static Map<Long,Integer>	getFiberNumWavelengthsMap(NetPlan netPlan) Returns the total number of wavelengths in each fiber.
static Map<Long,Integer>	getFiberNumWavelengthsMap(NetPlan netPlan, long layerId) Returns the total number of wavelengths in each fiber.
static int[]	getFiberNumWavelengthsVector(NetPlan netPlan) Returns the total number of wavelengths in each fiber, where item 0 corresponds to first fiber in the network, item 1 to the second one, and so on.
static int[]	getFiberNumWavelengthsVector(NetPlan netPlan, long layerId) Returns the total number of wavelengths in each fiber, where item 0 corresponds to first fiber in the network, item 1 to the second one, and so on.
static Map<Long,Set<Integer>>	getFiberWavelengthOccupancyMap(NetPlan netPlan) Returns the set of used wavelengths per fiber.
static Map<Long,Set<Integer>>	getFiberWavelengthOccupancyMap(NetPlan netPlan, long layerId) Returns the set of used wavelengths per fiber.
static int[]	getLightpathSeqRegenerators(NetPlan netPlan, long lightpathId) Returns the sequence of regenerators/wavelength converters for the given lightpath.
static int[]	getLightpathSeqRegenerators(NetPlan netPlan, long layerId, long lightpathId) Returns the sequence of regenerators/wavelength converters for the given lightpath.
static int[]	getLightpathSeqWavelengths(NetPlan netPlan, long lightpathId) Returns the sequence of wavelengths for the given lightpath.
static int[]	getLightpathSeqWavelengths(NetPlan netPlan, long layerId, long lightpathId) Returns the sequence of wavelengths for the given lightpath.
static Map<Long,Integer>	getNodeRegeneratorOccupancyMap(NetPlan netPlan) Returns the number of regenerators installed per node.
static Map<Long,Integer>	getNodeRegeneratorOccupancyMap(NetPlan netPlan, long layerId) Returns the number of regenerators installed per node.
static int[]	getProtectionLightpathSeqRegenerators(NetPlan netPlan, long protectionLightpathId) Returns the sequence of regenerators/wavelength converters for the given lightpath.
static int[]	getProtectionLightpathSeqRegenerators(NetPlan netPlan, long layerId, long protectionLightpathId) Returns the sequence of regenerators/wavelength converters for the given lightpath.
static int[]	getProtectionLightpathSeqWavelengths(NetPlan netPlan, long protectionLightpathId) Returns the sequence of wavelengths for a given protection lightpath.
static int[]	getProtectionLightpathSeqWavelengths(NetPlan netPlan, long layerId, long protectionLightpathId) Returns the sequence of wavelengths for a given protection lightpath.
static List<Set<Long>>	getWavelengthFiberOccupancy(NetPlan netPlan) Returns the set of fibers occupied in each wavelength.
static List<Set<Long>>	getWavelengthFiberOccupancy(NetPlan netPlan, long layerId) Returns the set of fibers occupied in each wavelength.
static int[]	parseSeqRegenerators(Map<String,String> attributeMap) Returns the sequence of regenerators/wavelength converters from an attribute map, where the associated key corresponds to SEQUENCE_OF_REGENERATORS_ATTRIBUTE_NAME.
static int[]	parseSeqWavelengths(Map<String,String> attributeMap) Returns the sequence of wavelengths from an attribute map, where the associated key corresponds to SEQUENCE_OF_WAVELENGTHS_ATTRIBUTE_NAME.
static void	releaseResources(List<Long> seqFibers, int[] seqWavelengths, List<Set<Long>> wavelengthFiberOccupancy) Updates wavelengthFiberOccupancy to consider that a lightpath is releasing used wavelengths.
static void	releaseResources(List<Long> seqFibers, int wavelengthId, List<Set<Long>> wavelengthFiberOccupancy) Updates wavelengthFiberOccupancy to consider that a lightpath is releasing used wavelengths.
static void	releaseResources(Map<Long,Pair<Long,Long>> fiberMap, List<Long> seqFibers, int[] seqWavelengths, List<Set<Long>> wavelengthFiberOccupancy, int[] seqRegenerators, Map<Long,Integer> nodeRegeneratorOccupancy) Updates wavelengthFiberOccupancy to consider that a lightpath is releasing used wavelengths.
static void	releaseResources(Map<Long,Pair<Long,Long>> fiberMap, List<Long> seqFibers, int wavelengthId, List<Set<Long>> wavelengthFiberOccupancy, int[] seqRegenerators, Map<Long,Integer> nodeRegeneratorOccupancy) Updates wavelengthFiberOccupancy to consider that a lightpath is releasing used wavelengths.
static void	setFiberNumWavelengths(NetPlan netPlan, long fiberId, int numWavelengths) Sets the number of wavelengths available on the given fiber.
static void	setFiberNumWavelengths(NetPlan netPlan, long layerId, long fiberId, int numWavelengths) Sets the number of wavelengths available on the given fiber.
static void	setFibersNumWavelengths(NetPlan netPlan, int numWavelengths) Sets the number of wavelengths available in each fiber to the same value.
static void	setFibersNumWavelengths(NetPlan netPlan, int[] w_f) Sets the number of wavelengths available in each fiber.
static void	setFibersNumWavelengths(NetPlan netPlan, long layerId, int numWavelengths) Sets the number of wavelengths available in each fiber to the same value.
static void	setFibersNumWavelengths(NetPlan netPlan, long layerId, int[] w_f) Sets the number of wavelengths available in each fiber.
static void	setFibersNumWavelengths(NetPlan netPlan, long layerId, Map<Long,Integer> w_f) Sets the number of wavelengths available in each fiber.
static void	setFibersNumWavelengths(NetPlan netPlan, Map<Long,Integer> w_f) Sets the number of wavelengths available in each fiber.
static void	setLightpathSeqRegenerators(NetPlan netPlan, long lpId, int[] seqRegenerators) Sets the sequence of regenerators/wavelength converters for a given lightpath.
static void	setLightpathSeqRegenerators(NetPlan netPlan, long layerId, long lpId, int[] seqRegenerators) Sets the sequence of regenerators/wavelength converters for a given lightpath.
static void	setLightpathSeqWavelengths(NetPlan netPlan, long lpId, int wavelengthId) Sets the current wavelength for the given lightpath, assuming no wavelength conversion.
static void	setLightpathSeqWavelengths(NetPlan netPlan, long lpId, int[] seqWavelengths) Sets the sequence of wavelengths for the given lightpath.
static void	setLightpathSeqWavelengths(NetPlan netPlan, long layerId, long lpId, int wavelengthId) Sets the current wavelength for the given lightpath, assuming no wavelength conversion.
static void	setLightpathSeqWavelengths(NetPlan netPlan, long layerId, long lpId, int[] seqWavelengths) Sets the sequence of wavelengths for the given lightpath.
static void	setProtectionLightpathSeqRegenerators(NetPlan netPlan, long protectionLightpathId, int[] seqRegenerators) Sets the sequence of regenerators/wavelength converters for a given protection lightpath.
static void	setProtectionLightpathSeqRegenerators(NetPlan netPlan, long layerId, long protectionLightpathId, int[] seqRegenerators) Sets the sequence of regenerators/wavelength converters for a given protection lightpath.
static void	setProtectionLightpathSeqWavelengths(NetPlan netPlan, long protectionLightpathId, int wavelengthId) Sets the sequence of wavelengths for a protection lightpath, assuming no wavelength conversion.
static void	setProtectionLightpathSeqWavelengths(NetPlan netPlan, long protectionLightpathId, int[] seqWavelengths) Sets the sequence of wavelengths for a protection lightpath.
static void	setProtectionLightpathSeqWavelengths(NetPlan netPlan, long layerId, long protectionLightpathId, int wavelengthId) Sets the sequence of wavelengths for a protection lightpath, assuming no wavelength conversion.
static void	setProtectionLightpathSeqWavelengths(NetPlan netPlan, long layerId, long protectionLightpathId, int[] seqWavelengths) Sets the sequence of wavelengths for a protection lightpath.
static int[]	WA_firstFit(Map<Long,Pair<Long,Long>> fiberMap, List<Long> seqFibers, Map<Long,Integer> w_f, List<Set<Long>> wavelengthFiberOccupancy) Wavelength assignment algorithm based on a first-fit fashion.
static Pair<int[],int[]>	WA_RPP_firstFit(Map<Long,Pair<Long,Long>> fiberMap, List<Long> seqFibers, Map<Long,Integer> w_f, List<Set<Long>> wavelengthFiberOccupancy, Map<Long,Double> l_f, Map<Long,Integer> nodeRegeneratorOccupancy, double maxRegeneratorDistanceInKm) Wavelength assignment algorithm based on a first-fit fashion assuming full wavelength conversion and regeneration.

Methods inherited from class Object

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

Field Detail

SEQUENCE_OF_REGENERATORS_ATTRIBUTE_NAME

public static final String SEQUENCE_OF_REGENERATORS_ATTRIBUTE_NAME

Route/protection segment attribute name for sequence of regenerators.

Since:

0.3.0

See Also:

Constant Field Values

SEQUENCE_OF_WAVELENGTHS_ATTRIBUTE_NAME

public static final String SEQUENCE_OF_WAVELENGTHS_ATTRIBUTE_NAME

Route/protection segment attribute name for sequence of wavelengths.

Since:

0.3.0

See Also:

Constant Field Values

Method Detail

allocateResources

public static void allocateResources(List<Long> seqFibers,
                     int[] seqWavelengths,
                     List<Set<Long>> wavelengthFiberOccupancy)

Updates wavelengthFiberOccupancy to consider that a new lightpath is occupying a wavelength in each fiber.

Parameters:

seqFibers - Sequence of traversed fibers

seqWavelengths - Sequence of wavelengths (as many as the number of links in the lightpath)

wavelengthFiberOccupancy - Set of occupied fibers in each wavelength

Since:

0.3.0

allocateResources

public static void allocateResources(List<Long> seqFibers,
                     int wavelengthId,
                     List<Set<Long>> wavelengthFiberOccupancy)

Updates wavelengthFiberOccupancy to consider that a new lightpath is occupying a wavelength in each fiber.

Parameters:

seqFibers - Sequence of traversed fibers

wavelengthId - Wavelength identifier (the same for all traversed fibers)

wavelengthFiberOccupancy - Set of occupied fibers in each wavelength

Since:

0.3.0

allocateResources

public static void allocateResources(Map<Long,Pair<Long,Long>> fiberMap,
                     List<Long> seqFibers,
                     int[] seqWavelengths,
                     List<Set<Long>> wavelengthFiberOccupancy,
                     int[] seqRegenerators,
                     Map<Long,Integer> nodeRegeneratorOccupancy)

Updates wavelengthFiberOccupancy to consider that a new lightpath is occupying a wavelength in each fiber.

Parameters:

fiberMap - Map of fibers, where the key is the unique fiber identifier and the value is a Pair representing the origin node and the destination node of the fiber, respectively. It is mandatory that can be iterated in ascending order of fiber identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

seqFibers - Sequence of traversed fibers

seqWavelengths - Sequence of wavelengths (as many as the number of links in the lightpath)

wavelengthFiberOccupancy - Set of occupied fibers in each wavelength

seqRegenerators - A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

nodeRegeneratorOccupancy - Number of regenerators installed per node

Since:

0.3.0

allocateResources

public static void allocateResources(Map<Long,Pair<Long,Long>> fiberMap,
                     List<Long> seqFibers,
                     int wavelengthId,
                     List<Set<Long>> wavelengthFiberOccupancy,
                     int[] seqRegenerators,
                     Map<Long,Integer> nodeRegeneratorOccupancy)

Updates wavelengthFiberOccupancy to consider that a new lightpath is occupying a wavelength in each fiber.

Parameters:

fiberMap - Map of fibers, where the key is the unique fiber identifier and the value is a Pair representing the origin node and the destination node of the fiber, respectively. It is mandatory that can be iterated in ascending order of fiber identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

seqFibers - Sequence of traversed fibers

wavelengthId - Wavelength identifier (the same for all traversed fibers)

wavelengthFiberOccupancy - Set of occupied fibers in each wavelength

seqRegenerators - A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

nodeRegeneratorOccupancy - Number of regenerators installed per node

Since:

0.3.0

checkConsistency

public static void checkConsistency(NetPlan netPlan)

Performs extra checks to those applicable to every network design, especially focused on WDM networks.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

Since:

0.2.3

checkConsistency

public static void checkConsistency(NetPlan netPlan,
                    long layerId)

Performs extra checks to those applicable to every network design, especially focused on WDM networks.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

Since:

0.3.0

computeRegeneratorPositions

public static int[] computeRegeneratorPositions(Map<Long,Pair<Long,Long>> fiberMap,
                                List<Long> seqFibers,
                                int[] seqWavelengths,
                                Map<Long,Double> l_f,
                                double maxRegeneratorDistanceInKm)

Returns the list of nodes within the lightpath route containing a regenerator, only following a distance criterium, assuming wavelength conversion is required.

Parameters:

fiberMap - Map of fibers, where the key is the unique fiber identifier and the value is a Pair representing the origin node and the destination node of the fiber, respectively. It is mandatory that can be iterated in ascending order of fiber identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

seqFibers - Sequence of traversed fibers

seqWavelengths - Sequence of wavelengths (as many as the number of links in the lightpath)

l_f - Physical length in km per fiber

maxRegeneratorDistanceInKm - Maximum regeneration distance

Returns:

A vector with as many elements as traversed links in the route/segment. Each element is a 1 if an optical regenerator is used at the origin node of the corresponding link, and a 0 if not. First element is always 0.

Since:

0.3.0

computeRegeneratorPositions

public static int[] computeRegeneratorPositions(Map<Long,Pair<Long,Long>> fiberMap,
                                List<Long> seqFibers,
                                Map<Long,Double> l_f,
                                double maxRegeneratorDistanceInKm)

Returns the list of nodes within the lightpath route containing a regenerator, only following a distance criterium, assuming no wavelength conversion is required.

Parameters:

fiberMap - Map of fibers, where the key is the unique fiber identifier and the value is a Pair representing the origin node and the destination node of the fiber, respectively. It is mandatory that can be iterated in ascending order of fiber identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

seqFibers - Sequence of traversed fibers

l_f - Physical length in km per fiber

maxRegeneratorDistanceInKm - Maximum regeneration distance

Returns:

A vector with as many elements as traversed links in the route/segment. Each element is a 1 if an optical regenerator is used at the origin node of the corresponding link, and a 0 if not. First element is always 0.

Since:

0.3.0

getFiberNumWavelengths

public static int getFiberNumWavelengths(NetPlan netPlan,
                         long fiberId)

Returns the number of wavelengths for the given fiber. It is equivalent to the method getLinkCapacity() from the NetPlan object, but converting capacity value from double to int.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

fiberId - Fiber identifier

Returns:

Number of wavelengths

Since:

0.3.0

getFiberNumWavelengths

public static int getFiberNumWavelengths(NetPlan netPlan,
                         long layerId,
                         long fiberId)

Returns the number of wavelengths for the given fiber. It is equivalent to the method getLinkCapacity() from the NetPlan object, but converting capacity value from double to int.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

fiberId - Fiber identifier

Returns:

Number of wavelengths

Since:

0.3.0

getFiberNumWavelengthsMap

public static Map<Long,Integer> getFiberNumWavelengthsMap(NetPlan netPlan)

Returns the total number of wavelengths in each fiber. It is equivalent to the method getLinkCapacityMap() from the NetPlan object, but converting capacity values from Double to Integer.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

Returns:

Number of wavelengths per fiber

Since:

0.3.0

getFiberNumWavelengthsMap

public static Map<Long,Integer> getFiberNumWavelengthsMap(NetPlan netPlan,
                                          long layerId)

Returns the total number of wavelengths in each fiber. It is equivalent to the method getLinkCapacityMap(layerId) from the NetPlan object, but converting capacity values from Double to Integer.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

Returns:

Number of wavelengths per fiber

Since:

0.3.0

getFiberNumWavelengthsVector

public static int[] getFiberNumWavelengthsVector(NetPlan netPlan)

Returns the total number of wavelengths in each fiber, where item 0 corresponds to first fiber in the network, item 1 to the second one, and so on.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

Returns:

Number of wavelengths per fiber

Since:

0.3.0

getFiberNumWavelengthsVector

public static int[] getFiberNumWavelengthsVector(NetPlan netPlan,
                                 long layerId)

Returns the total number of wavelengths in each fiber, where item 0 corresponds to first fiber in the network, item 1 to the second one, and so on.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

Returns:

Number of wavelengths per fiber

Since:

0.3.0

getFiberWavelengthOccupancyMap

public static Map<Long,Set<Integer>> getFiberWavelengthOccupancyMap(NetPlan netPlan)

Returns the set of used wavelengths per fiber.

Parameters:

netPlan - A NetPlan representing a physical topology

Returns:

Set of used wavelengths per fiber

Since:

0.3.0

getFiberWavelengthOccupancyMap

public static Map<Long,Set<Integer>> getFiberWavelengthOccupancyMap(NetPlan netPlan,
                                                    long layerId)

Returns the set of used wavelengths per fiber.

Parameters:

netPlan - A NetPlan representing a physical topology

layerId - Layer identifier

Returns:

Set of used wavelengths per fiber

Since:

0.3.0

getLightpathSeqRegenerators

public static int[] getLightpathSeqRegenerators(NetPlan netPlan,
                                long lightpathId)

Returns the sequence of regenerators/wavelength converters for the given lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

lightpathId - Lightpath identifier

Returns:

A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

Since:

0.3.0

getLightpathSeqRegenerators

public static int[] getLightpathSeqRegenerators(NetPlan netPlan,
                                long layerId,
                                long lightpathId)

Returns the sequence of regenerators/wavelength converters for the given lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

lightpathId - Lightpath identifier

Returns:

A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

Since:

0.3.0

getLightpathSeqWavelengths

public static int[] getLightpathSeqWavelengths(NetPlan netPlan,
                               long lightpathId)

Returns the sequence of wavelengths for the given lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

lightpathId - Lightpath identifier

Returns:

Sequence of wavelengths

Since:

0.3.0

getLightpathSeqWavelengths

public static int[] getLightpathSeqWavelengths(NetPlan netPlan,
                               long layerId,
                               long lightpathId)

Returns the sequence of wavelengths for the given lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

lightpathId - Lightpath identifier

Returns:

Sequence of wavelengths

Since:

0.3.0

getNodeRegeneratorOccupancyMap

public static Map<Long,Integer> getNodeRegeneratorOccupancyMap(NetPlan netPlan)

Returns the number of regenerators installed per node.

Parameters:

netPlan - A NetPlan representing a physical topology

Returns:

Number of regenerators installed per node

Since:

0.3.0

getNodeRegeneratorOccupancyMap

public static Map<Long,Integer> getNodeRegeneratorOccupancyMap(NetPlan netPlan,
                                               long layerId)

Returns the number of regenerators installed per node.

Parameters:

netPlan - A NetPlan representing a physical topology

layerId - Layer identifier

Returns:

Number of regenerators installed per node

Since:

0.3.0

getProtectionLightpathSeqRegenerators

public static int[] getProtectionLightpathSeqRegenerators(NetPlan netPlan,
                                          long protectionLightpathId)

Returns the sequence of regenerators/wavelength converters for the given lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

protectionLightpathId - Protection lightpath identifier

Returns:

A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

Since:

0.3.0

getProtectionLightpathSeqRegenerators

public static int[] getProtectionLightpathSeqRegenerators(NetPlan netPlan,
                                          long layerId,
                                          long protectionLightpathId)

Returns the sequence of regenerators/wavelength converters for the given lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

protectionLightpathId - Protection lightpath identifier

Returns:

A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

Since:

0.3.0

getProtectionLightpathSeqWavelengths

public static int[] getProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                         long protectionLightpathId)

Returns the sequence of wavelengths for a given protection lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

protectionLightpathId - Protection lightpath identifier

Returns:

Sequence of wavelengths

Since:

0.3.0

getProtectionLightpathSeqWavelengths

public static int[] getProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                         long layerId,
                                         long protectionLightpathId)

Returns the sequence of wavelengths for a given protection lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

protectionLightpathId - Protection lightpath identifier

Returns:

Sequence of wavelengths

Since:

0.3.0

getWavelengthFiberOccupancy

public static List<Set<Long>> getWavelengthFiberOccupancy(NetPlan netPlan)

Returns the set of fibers occupied in each wavelength.

Parameters:

netPlan - A NetPlan representing a physical topology

Returns:

Set of fibers occupied in each wavelength

Since:

0.3.0

getWavelengthFiberOccupancy

public static List<Set<Long>> getWavelengthFiberOccupancy(NetPlan netPlan,
                                          long layerId)

Returns the set of fibers occupied in each wavelength.

Parameters:

netPlan - A NetPlan representing a physical topology

layerId - Layer identifier

Returns:

Set of fibers occupied in each wavelength

Since:

0.3.0

parseSeqRegenerators

public static int[] parseSeqRegenerators(Map<String,String> attributeMap)

Returns the sequence of regenerators/wavelength converters from an attribute map, where the associated key corresponds to SEQUENCE_OF_REGENERATORS_ATTRIBUTE_NAME.

Parameters:

attributeMap - Attribute map, where key is the attribute name and the value is the parameter value

Returns:

Sequence of regenerators/wavelength converters

Since:

0.3.0

parseSeqWavelengths

public static int[] parseSeqWavelengths(Map<String,String> attributeMap)

Returns the sequence of wavelengths from an attribute map, where the associated key corresponds to SEQUENCE_OF_WAVELENGTHS_ATTRIBUTE_NAME.

Parameters:

attributeMap - Attribute map, where key is the attribute name and the value is the parameter value

Returns:

Sequence of wavelengths

Since:

0.3.0

releaseResources

public static void releaseResources(List<Long> seqFibers,
                    int[] seqWavelengths,
                    List<Set<Long>> wavelengthFiberOccupancy)

Updates wavelengthFiberOccupancy to consider that a lightpath is releasing used wavelengths.

Parameters:

seqFibers - Sequence of traversed fibers

seqWavelengths - Sequence of wavelengths (as many as the number of links in the lightpath)

wavelengthFiberOccupancy - Set of occupied fibers in each wavelength

Since:

0.3.0

releaseResources

public static void releaseResources(List<Long> seqFibers,
                    int wavelengthId,
                    List<Set<Long>> wavelengthFiberOccupancy)

Updates wavelengthFiberOccupancy to consider that a lightpath is releasing used wavelengths.

Parameters:

seqFibers - Sequence of traversed fibers

wavelengthId - Wavelength identifier (the same for all traversed fibers)

wavelengthFiberOccupancy - Set of occupied fibers in each wavelength

Since:

0.3.0

releaseResources

public static void releaseResources(Map<Long,Pair<Long,Long>> fiberMap,
                    List<Long> seqFibers,
                    int[] seqWavelengths,
                    List<Set<Long>> wavelengthFiberOccupancy,
                    int[] seqRegenerators,
                    Map<Long,Integer> nodeRegeneratorOccupancy)

Updates wavelengthFiberOccupancy to consider that a lightpath is releasing used wavelengths.

Parameters:

fiberMap - Map of fibers, where the key is the unique fiber identifier and the value is a Pair representing the origin node and the destination node of the fiber, respectively. It is mandatory that can be iterated in ascending order of fiber identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

seqFibers - Sequence of traversed fibers

seqWavelengths - Sequence of wavelengths (as many as the number of links in the lightpath)

wavelengthFiberOccupancy - Set of occupied fibers in each wavelength

seqRegenerators - A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

nodeRegeneratorOccupancy - Number of regenerators installed per node

Since:

0.3.0

releaseResources

public static void releaseResources(Map<Long,Pair<Long,Long>> fiberMap,
                    List<Long> seqFibers,
                    int wavelengthId,
                    List<Set<Long>> wavelengthFiberOccupancy,
                    int[] seqRegenerators,
                    Map<Long,Integer> nodeRegeneratorOccupancy)

Updates wavelengthFiberOccupancy to consider that a lightpath is releasing used wavelengths.

Parameters:

fiberMap - Map of fibers, where the key is the unique fiber identifier and the value is a Pair representing the origin node and the destination node of the fiber, respectively. It is mandatory that can be iterated in ascending order of fiber identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

seqFibers - Sequence of traversed fibers

wavelengthId - Wavelength identifier (the same for all traversed fibers)

wavelengthFiberOccupancy - Set of occupied fibers in each wavelength

seqRegenerators - A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

nodeRegeneratorOccupancy - Number of regenerators installed per node

Since:

0.3.0

setFiberNumWavelengths

public static void setFiberNumWavelengths(NetPlan netPlan,
                          long fiberId,
                          int numWavelengths)

Sets the number of wavelengths available on the given fiber.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

fiberId - Fiber identifier

numWavelengths - Number of wavelengths for the given fiber

Since:

0.3.0

setFiberNumWavelengths

public static void setFiberNumWavelengths(NetPlan netPlan,
                          long layerId,
                          long fiberId,
                          int numWavelengths)

Sets the number of wavelengths available on the given fiber.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

fiberId - Fiber identifier

numWavelengths - Number of wavelengths for the given fiber

Since:

0.3.0

setFibersNumWavelengths

public static void setFibersNumWavelengths(NetPlan netPlan,
                           int numWavelengths)

Sets the number of wavelengths available in each fiber to the same value.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

numWavelengths - Number of wavelengths for all fibers

Since:

0.2.3

setFibersNumWavelengths

public static void setFibersNumWavelengths(NetPlan netPlan,
                           int[] w_f)

Sets the number of wavelengths available in each fiber.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

w_f - Number of wavelengths per fiber

Since:

0.2.3

setFibersNumWavelengths

public static void setFibersNumWavelengths(NetPlan netPlan,
                           long layerId,
                           int numWavelengths)

Sets the number of wavelengths available in each fiber to the same value.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

numWavelengths - Number of wavelengths for all fibers

Since:

0.3.0

setFibersNumWavelengths

public static void setFibersNumWavelengths(NetPlan netPlan,
                           long layerId,
                           int[] w_f)

Sets the number of wavelengths available in each fiber.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

w_f - Number of wavelengths per fiber

Since:

0.3.0

setFibersNumWavelengths

public static void setFibersNumWavelengths(NetPlan netPlan,
                           long layerId,
                           Map<Long,Integer> w_f)

Sets the number of wavelengths available in each fiber.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

w_f - Number of wavelengths per fiber

Since:

0.3.0

setFibersNumWavelengths

public static void setFibersNumWavelengths(NetPlan netPlan,
                           Map<Long,Integer> w_f)

Sets the number of wavelengths available in each fiber.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

w_f - Number of wavelengths per fiber

Since:

0.3.0

setLightpathSeqRegenerators

public static void setLightpathSeqRegenerators(NetPlan netPlan,
                               long lpId,
                               int[] seqRegenerators)

Sets the sequence of regenerators/wavelength converters for a given lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

lpId - Lightpath identifier

seqRegenerators - A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

Since:

0.3.0

setLightpathSeqRegenerators

public static void setLightpathSeqRegenerators(NetPlan netPlan,
                               long layerId,
                               long lpId,
                               int[] seqRegenerators)

Sets the sequence of regenerators/wavelength converters for a given lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

lpId - Lightpath identifier

seqRegenerators - A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

Since:

0.3.0

setLightpathSeqWavelengths

public static void setLightpathSeqWavelengths(NetPlan netPlan,
                              long lpId,
                              int wavelengthId)

Sets the current wavelength for the given lightpath, assuming no wavelength conversion.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

lpId - Lightpath identifier

wavelengthId - Wavelength identifier (the same for all traversed fibers)

Since:

0.3.0

setLightpathSeqWavelengths

public static void setLightpathSeqWavelengths(NetPlan netPlan,
                              long lpId,
                              int[] seqWavelengths)

Sets the sequence of wavelengths for the given lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

lpId - Lightpath identifier

seqWavelengths - Sequence of wavelengths (as many as the number of links in the lightpath)

Since:

0.3.0

setLightpathSeqWavelengths

public static void setLightpathSeqWavelengths(NetPlan netPlan,
                              long layerId,
                              long lpId,
                              int wavelengthId)

Sets the current wavelength for the given lightpath, assuming no wavelength conversion.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

lpId - Lightpath identifier

wavelengthId - Wavelength identifier (the same for all traversed fibers)

Since:

0.3.0

setLightpathSeqWavelengths

public static void setLightpathSeqWavelengths(NetPlan netPlan,
                              long layerId,
                              long lpId,
                              int[] seqWavelengths)

Sets the sequence of wavelengths for the given lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

lpId - Lightpath identifier

seqWavelengths - Sequence of wavelengths (as many as the number of links in the lightpath)

Since:

0.3.0

setProtectionLightpathSeqRegenerators

public static void setProtectionLightpathSeqRegenerators(NetPlan netPlan,
                                         long protectionLightpathId,
                                         int[] seqRegenerators)

Sets the sequence of regenerators/wavelength converters for a given protection lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

protectionLightpathId - Protection lightpath identifier

seqRegenerators - A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

Since:

0.3.0

setProtectionLightpathSeqRegenerators

public static void setProtectionLightpathSeqRegenerators(NetPlan netPlan,
                                         long layerId,
                                         long protectionLightpathId,
                                         int[] seqRegenerators)

Sets the sequence of regenerators/wavelength converters for a given protection lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

protectionLightpathId - Protection lightpath identifier

seqRegenerators - A 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

Since:

0.3.0

setProtectionLightpathSeqWavelengths

public static void setProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                        long protectionLightpathId,
                                        int wavelengthId)

Sets the sequence of wavelengths for a protection lightpath, assuming no wavelength conversion.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

protectionLightpathId - Protection lightpath identifier

wavelengthId - Wavelength identifier (the same for all traversed fibers)

Since:

0.3.0

setProtectionLightpathSeqWavelengths

public static void setProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                        long protectionLightpathId,
                                        int[] seqWavelengths)

Sets the sequence of wavelengths for a protection lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

protectionLightpathId - Protection lightpath identifier

seqWavelengths - Sequence of wavelengths (as many as the number of links in the lightpath)

Since:

0.3.0

setProtectionLightpathSeqWavelengths

public static void setProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                        long layerId,
                                        long protectionLightpathId,
                                        int wavelengthId)

Sets the sequence of wavelengths for a protection lightpath, assuming no wavelength conversion.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

protectionLightpathId - Protection lightpath identifier

wavelengthId - Wavelength identifier (the same for all traversed fibers)

Since:

0.3.0

setProtectionLightpathSeqWavelengths

public static void setProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                        long layerId,
                                        long protectionLightpathId,
                                        int[] seqWavelengths)

Sets the sequence of wavelengths for a protection lightpath.

Parameters:

netPlan - A NetPlan representing a WDM physical topology

layerId - Layer identifier

protectionLightpathId - Protection lightpath identifier

seqWavelengths - Sequence of wavelengths (as many as the number of links in the lightpath)

Since:

0.3.0

WA_firstFit

public static int[] WA_firstFit(Map<Long,Pair<Long,Long>> fiberMap,
                List<Long> seqFibers,
                Map<Long,Integer> w_f,
                List<Set<Long>> wavelengthFiberOccupancy)

Wavelength assignment algorithm based on a first-fit fashion. Wavelengths are indexed from 0 to W_f-1, where W_f is the number of wavelengths supported by fiber f. Then, the wavelength assigned to each lightpath (along the whole physical route) is the minimum index among the common free-wavelength set for all traversed fibers.

In case a lightpath cannot be allocated, the corresponding sequence of wavelengths (seqWavelengths parameter) will be an empty array.

Important: wavelengthFiberOccupancy is not updated, so subsequent usage of allocateResources method is encouraged.

Parameters:

fiberMap - Map of fibers, where the key is the unique fiber identifier and the value is a Pair representing the origin node and the destination node of the fiber, respectively. It is mandatory that can be iterated in ascending order of fiber identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

seqFibers - Sequence of traversed fibers

w_f - Number of wavelengths per fiber

wavelengthFiberOccupancy - Set of occupied fibers in each wavelength

Returns:

Sequence of wavelengths traversed by each lightpath

Since:

0.3.0

WA_RPP_firstFit

public static Pair<int[],int[]> WA_RPP_firstFit(Map<Long,Pair<Long,Long>> fiberMap,
                                List<Long> seqFibers,
                                Map<Long,Integer> w_f,
                                List<Set<Long>> wavelengthFiberOccupancy,
                                Map<Long,Double> l_f,
                                Map<Long,Integer> nodeRegeneratorOccupancy,
                                double maxRegeneratorDistanceInKm)

Wavelength assignment algorithm based on a first-fit fashion assuming full wavelength conversion and regeneration. Each node selects the first free wavelength for its output fiber, and next nodes in the lightpath try to maintain it. If not possible, or regeneration is needed, then include a regenerator (can act also as a full wavelength converter) and search for the first free wavelength, and so on.

In case a lightpath cannot be allocated, the corresponding sequence of wavelengths (seqWavelengths parameter) will be an empty array.

Parameters:

fiberMap - Map of fibers, where the key is the unique fiber identifier and the value is a Pair representing the origin node and the destination node of the fiber, respectively. It is mandatory that can be iterated in ascending order of fiber identifier (i.e. using TreeMap or those Map objects returned from Net2Plan object

seqFibers - Sequence of traversed fibers

w_f - Number of wavelengths per fiber

wavelengthFiberOccupancy - Set of occupied fibers in each wavelength

l_f - Physical length in km per fiber

nodeRegeneratorOccupancy - Number of regenerators installed per node

maxRegeneratorDistanceInKm - Maximum regeneration distance

Returns:

Sequence of wavelengths traversed by each lightpath, and a 0-1 array indicating whether (1) or not (0) a regenerator/wavelength converter is required at the origin node of the corresponding fiber

Since:

0.3.0