WDMUtils.RSA (net2plan-javadoc 0.6.0.1 API)

java.lang.Object
- com.net2plan.libraries.WDMUtils.RSA

Enclosing class:

WDMUtils
```
public static class WDMUtils.RSA
extends Object
```
This class represents a Routing and Spectrum Assignment, valid for a lightpath in both fixed and flexi-grid WDM networks. This comprises a sequence of links, and for each link the set of frequency slots occupied, and for each traversed node but the first, whether or not the optical signal goes through an optical signal regeneration (and thus, a regenerator should be allocated there for this). The number of slots occupied is the same in all the traversed links.

Field Summary

Fields
Modifier and Type	Field and Description
`Node`	`egressNode` The end node of the lightpath
`Node`	`ingressNode` The initial node of the lightpath
`IntMatrix2D`	`seqFrequencySlots_se` A 2D integer matrix with as many columns as traversed links (in the same order), and rows as the number of frequency slots occupied (the same in all the links).
`List<Link>`	`seqLinks` The sequence of traversed fibers
`int[]`	`seqRegeneratorsOccupancy_e` An integer vector with one coordinate per traversed fiber.

Constructor Summary

Constructors
Constructor and Description
`RSA(List<Link> seqLinks, int occupiedSlotId)` Creates a RSA where the same one single slot is occupied in all the traversed links.
`RSA(List<Link> seqLinks, int initialSlot, int numSlots)` Creates a RSA with the same set of contigous slots occupied in all the traversed fibers
`RSA(List<Link> seqLinks, int initialSlot, int numSlots, int[] seqRegenerators_e)` Creates a RSA with the same set of contigous slots occupied in all the traversed fibers
`RSA(List<Link> seqLinks, IntMatrix2D seqFrequencySlots_se)` Equivalent to `RSA (seqLinks , seqFrequencySlot, null)`
`RSA(List<Link> seqLinks, IntMatrix2D seqFrequencySlots_se, int[] seqRegenerators_e)` Creates a RSA object from the provided information
`RSA(Route r, boolean initializeWithTheInitialState)` Creates a RSA object reading the information from the existing Route object (and its WDM-related attributes).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkFrequencySlotConversionOccupiesARegenerator()` Checks that in every node where the frequency slots of the RSA change, a regenerator is placed (if not, an exception is raised).
`boolean`	`equals(WDMUtils.RSA rsa)` Returns true if this RSA has the same sequence of links, occupied slots and regenerators as the given RSA
`double`	`getLengthInKm()` Gets the length of the RSA in km, summing the length of the traversed fibers
`List<Node>`	`getNodesWithFrequencySlotConversion()` Gets the list of nodes (in the same order as they are traversed) where frequency slot changes in the RSA.
`int`	`getNumSlots()` Gets the number of slots occupied in this RSA (the same in all the traversed fibers)
`List<Node>`	`getSignalRegenerationNodes()` Gets the list of nodes (in the same order as they are traversed) where a regenerator has been placed.
`boolean`	`hasFrequencySlotConversions()` Returns whether or not frequency slot conversions occur in this RSA (and thus converters would be needed)
`boolean`	`isDown()` Returns true if the path in the RSA is down (traverses a node/link that is down)
`boolean`	`isFrequencySlotContiguous()` Returns true if in ALL the links, the slots occupied are contigous (e.g.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - egressNode
```
public final Node egressNode
```
    The end node of the lightpath
  - ingressNode
```
public final Node ingressNode
```
    The initial node of the lightpath
  - seqFrequencySlots_se
```
public final IntMatrix2D seqFrequencySlots_se
```
    A 2D integer matrix with as many columns as traversed links (in the same order), and rows as the number of frequency slots occupied (the same in all the links). Position (i,j) of the array is the identifier of the i-th slot used in the fiber traversed in the j-th place. Recall that an slot identifier is an integer number between zero and the number of slots in the grid minus one.
  - seqLinks
```
public final List<Link> seqLinks
```
    The sequence of traversed fibers
  - seqRegeneratorsOccupancy_e
```
public final int[] seqRegeneratorsOccupancy_e
```
    An integer vector with one coordinate per traversed fiber. A 1 is set in the i-th position if a regenerator is needed at origin node of the fiber traversed in the i-th place, and a 0 otherwise.
- Constructor Detail
  - RSA
```
public RSA(List<Link> seqLinks,
           int occupiedSlotId)
```
    Creates a RSA where the same one single slot is occupied in all the traversed links. Typically used in fixed-grid networks without wavelength conversion. Equivalent to RSA (seqLinks , occupiedSlotId , 1)
    
    Parameters:
    
    seqLinks - sequence of traversed fibers
    
    occupiedSlotId - the slot occupied
  - RSA
```
public RSA(List<Link> seqLinks,
           int initialSlot,
           int numSlots)
```
    Creates a RSA with the same set of contigous slots occupied in all the traversed fibers
    
    Parameters:
    
    seqLinks - Sequence of traversed fiber
    
    initialSlot - id of the initial frequency slot occupied
    
    numSlots - number of contiguous slots of the RSA
  - RSA
```
public RSA(List<Link> seqLinks,
           int initialSlot,
           int numSlots,
           int[] seqRegenerators_e)
```
    Creates a RSA with the same set of contigous slots occupied in all the traversed fibers
    
    Parameters:
    
    seqLinks - Sequence of traversed fiber
    
    initialSlot - id of the initial frequency slot occupied
    
    numSlots - number of contiguous slots of the RSA
    
    seqRegenerators_e - vector with the sequence of traversed regenerators information (if null, no regenerators are placed)
  - RSA
```
public RSA(List<Link> seqLinks,
           IntMatrix2D seqFrequencySlots_se)
```
    Equivalent to RSA (seqLinks , seqFrequencySlot, null)
    
    Parameters:
    
    seqLinks - sequence of traversed fibers (a copy is made internally)
    
    seqFrequencySlots_se - 2D array with the sequence of frequency slots information.
  - RSA
```
public RSA(List<Link> seqLinks,
           IntMatrix2D seqFrequencySlots_se,
           int[] seqRegenerators_e)
```
    Creates a RSA object from the provided information
    
    Parameters:
    
    seqLinks - sequence of traversed fibers (a copy is made internally)
    
    seqFrequencySlots_se - 2D array with the sequence of frequency slots information.
    
    seqRegenerators_e - vector with the sequence of traversed regenerators information (if null, no regenerators are placed)
  - RSA
```
public RSA(Route r,
           boolean initializeWithTheInitialState)
```
    Creates a RSA object reading the information from the existing Route object (and its WDM-related attributes).
    
    Parameters:
    
    r - the route object
    
    initializeWithTheInitialState - if true, the RSA object created gets the information from the route primary path: sequence of links, and if not, from the route current sequence of traversed links.
- Method Detail
  - checkFrequencySlotConversionOccupiesARegenerator
```
public void checkFrequencySlotConversionOccupiesARegenerator()
```
    Checks that in every node where the frequency slots of the RSA change, a regenerator is placed (if not, an exception is raised). This is assuming that regenerators are the equipment needed to perform wavelength/frequency slot conversion
  - equals
```
public boolean equals(WDMUtils.RSA rsa)
```
    Returns true if this RSA has the same sequence of links, occupied slots and regenerators as the given RSA
    
    Parameters:
    
    rsa - The RSA
    
    Returns:
    
    see above
  - getLengthInKm
```
public double getLengthInKm()
```
    Gets the length of the RSA in km, summing the length of the traversed fibers
    
    Returns:
    
    the length in km
  - getNodesWithFrequencySlotConversion
```
public List<Node> getNodesWithFrequencySlotConversion()
```
    Gets the list of nodes (in the same order as they are traversed) where frequency slot changes in the RSA.
    
    Returns:
    
    a list of nodes where frequency slot changes (it is assumed that devices making frequency slot conversion were placed there)
  - getNumSlots
```
public int getNumSlots()
```
    Gets the number of slots occupied in this RSA (the same in all the traversed fibers)
    
    Returns:
    
    the number of slots
  - getSignalRegenerationNodes
```
public List<Node> getSignalRegenerationNodes()
```
    Gets the list of nodes (in the same order as they are traversed) where a regenerator has been placed.
    
    Returns:
    
    the list of nodes where regenerators have been placed, according to seqRegeneratorsOccupancy_e
  - hasFrequencySlotConversions
```
public boolean hasFrequencySlotConversions()
```
    Returns whether or not frequency slot conversions occur in this RSA (and thus converters would be needed)
    
    Returns:
    
    true if frequency slot conversion occurs, false otherwise
  - isDown
```
public boolean isDown()
```
    Returns true if the path in the RSA is down (traverses a node/link that is down)
    
    Returns:
    
    see above
  - isFrequencySlotContiguous
```
public boolean isFrequencySlotContiguous()
```
    Returns true if in ALL the links, the slots occupied are contigous (e.g. slots 12,13,14 are contiguous), or false otherwise (p.e. if in a link it occupied slots 12, 16, 17, they are not contigous and returns false). Note that is frequency slots occupied are not the same in all the links, but inside eachlink they are contigous, the method returns true
    
    Returns:
    
    true if frequency slots occupied are contiguous in all the links
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WDMUtils.RSA

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

egressNode

ingressNode

seqFrequencySlots_se

seqLinks

seqRegeneratorsOccupancy_e

Constructor Detail

RSA

RSA

RSA

RSA

RSA

RSA

Method Detail

checkFrequencySlotConversionOccupiesARegenerator

equals

getLengthInKm

getNodesWithFrequencySlotConversion

getNumSlots

getSignalRegenerationNodes

hasFrequencySlotConversions

isDown

isFrequencySlotContiguous

toString