OpticalSpectrumManager (net2plan-javadoc 0.6.0.1 API)

java.lang.Object
- com.net2plan.research.niw.networkModel.OpticalSpectrumManager

```
public class OpticalSpectrumManager
extends Object
```
This class is used to account for the occupation of the optical spectrum in the network. The object can be created from an existing network. To make a valid optical design, the user is responsible of using this object methods to check if routing and spectrum assignments (RSAs) of new lightpaths are valid. Also, this object includes some methods for simple RSA recommendations, e.g. first-fit assignments (occupy idle and valid resources) Occupation is represented by optical slots, each defined by an integer. The central frequency of optical slot i is 193.1+i*0.0125 THz. All optical slots are supposed to have the same width 12.5 GHz (see WNetConstants)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allocateOccupation(WLightpathUnregenerated lp, Collection<WFiber> wdmLinks, SortedSet<Integer> slotIds)` Accounts for the occupation of a lightpath, updating the information in the spectrum manager
`void`	`checkNetworkSlotOccupation()` Checks if the optical slot occupation --
`static OpticalSpectrumManager`	`createFromRegularLps(WNet net)` Creates this object, asociated to a given network
`SortedSet<Integer>`	`getAvailableSlotIds(Collection<WFiber> wdmLinks)` Returns the set of the optical slots ids that are idle in ALL the fibers provided
`SortedSet<Integer>`	`getIdleOpticalSlotIds(WFiber wdmLink)` Returns the optical slots that are usable (valid and idle) in the given fiber
`static Pair<Integer,Integer>`	`getMinimumAndMaximumValidSlotIdsInTheGrid(Collection<WFiber> wdmLinks)` For the provided collection of fibers, indicates the minimum and maximum optical slot id that is valid for all the fibers in the collection
`SortedSet<Integer>`	`getOccupiedOpticalSlotIds(WFiber fiber)` Given a fiber, returns the set of optical slots occupied by at least one traversing lightpath
`SortedMap<Integer,SortedSet<WLightpathUnregenerated>>`	`getOccupiedResources(WFiber fiber)` Given a fiber, returns a map with the occupied optical slot ids, mapped to the set of lightpaths that occupy it.
`SortedMap<WFiber,SortedSet<Integer>>`	`getOccupiedResources(WLightpathRequest lp)` Given a lightpath request, returns the optical slots occupied in the traversed fibers
`List<List<WFiber>>`	`getRegenerationPoints(List<WFiber> seqFibers, double maxUnregeneratedDistanceInKm)` Given a sequence of fibers (i.e.
`boolean`	`isAllocatable(Collection<WFiber> wdmLinks, SortedSet<Integer> slotIds)` Given a set of fibers and a set of optical slots, returns true if ALL the optical slots are idle in ALL the fibers
`boolean`	`isAlreadyAccounted(WLightpathUnregenerated lp)` Returns true if the indicated lightpath is already accounted in this optical spectrm manager.
`boolean`	`isOpticalSlotIdsValidAndIdle(WFiber wdmLink, SortedSet<Integer> slotsIds)` Indicates if the optical slots are usable (valid and idle) in the given fiber
`boolean`	`isSpectrumOccupationOk()` Returns true if the design is ok respect to spectrum occupation: no optical slot in any fiber is occupied by more than one lightpath, and no optical slot in a fiber is outside the valid range for that fiber
`String`	`printReport()` Prints a report with the occupation (for debugging pruposes)
`void`	`releaseOccupation(WLightpathUnregenerated lp)` Releases all the optical slots occupied for a given lightpath in this manager
`Optional<SortedSet<Integer>>`	`spectrumAssignment_firstFit(Collection<WFiber> seqFibers, int numContiguousSlotsRequired, Optional<Integer> minimumInitialSlotId)` Searches for a first-fit assignment.
`Optional<Pair<SortedSet<Integer>,SortedSet<Integer>>>`	`spectrumAssignment_firstFitTwoRoutes(Collection<WFiber> seqFibers_1, Collection<WFiber> seqFibers_2, int numContiguousSlotsRequired)` Searches for a first-fit assignment for the two given paths, so optical slots can be different for each.

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

- Method Detail
  - allocateOccupation
```
public boolean allocateOccupation(WLightpathUnregenerated lp,
                                  Collection<WFiber> wdmLinks,
                                  SortedSet<Integer> slotIds)
```
    Accounts for the occupation of a lightpath, updating the information in the spectrum manager
    
    Parameters:
    
    lp - the lightpath
    
    wdmLinks - the set of fibers where optical resources are occupied by this lightpath. This is typically the set of lightpath traversed fibers. In filterless technologies, this may also include other fibers not intentionally traversed, but where the spectrum is also occupied
    
    slotIds - the optical slot ids
    
    Returns:
    
    see above
  - checkNetworkSlotOccupation
```
public void checkNetworkSlotOccupation()
```
    Checks if the optical slot occupation --
  - createFromRegularLps
```
public static OpticalSpectrumManager createFromRegularLps(WNet net)
```
    Creates this object, asociated to a given network
    
    Parameters:
    
    net - the network
    
    Returns:
    
    see above
  - getAvailableSlotIds
```
public SortedSet<Integer> getAvailableSlotIds(Collection<WFiber> wdmLinks)
```
    Returns the set of the optical slots ids that are idle in ALL the fibers provided
    
    Parameters:
    
    wdmLinks - the set of fibers
    
    Returns:
    
    see above
  - getIdleOpticalSlotIds
```
public SortedSet<Integer> getIdleOpticalSlotIds(WFiber wdmLink)
```
    Returns the optical slots that are usable (valid and idle) in the given fiber
    
    Parameters:
    
    wdmLink - see above
    
    Returns:
    
    see above
  - getMinimumAndMaximumValidSlotIdsInTheGrid
```
public static Pair<Integer,Integer> getMinimumAndMaximumValidSlotIdsInTheGrid(Collection<WFiber> wdmLinks)
```
    For the provided collection of fibers, indicates the minimum and maximum optical slot id that is valid for all the fibers in the collection
    
    Parameters:
    
    wdmLinks - see above
    
    Returns:
    
    see above
  - getOccupiedOpticalSlotIds
```
public SortedSet<Integer> getOccupiedOpticalSlotIds(WFiber fiber)
```
    Given a fiber, returns the set of optical slots occupied by at least one traversing lightpath
    
    Parameters:
    
    fiber - see above
    
    Returns:
    
    see above
  - getOccupiedResources
```
public SortedMap<Integer,SortedSet<WLightpathUnregenerated>> getOccupiedResources(WFiber fiber)
```
    Given a fiber, returns a map with the occupied optical slot ids, mapped to the set of lightpaths that occupy it. Note that if more than one lightpath occupies a given slot, means that spectrum clashing occurs in that slot
    
    Parameters:
    
    fiber - the input fiber
    
    Returns:
    
    see above
  - getOccupiedResources
```
public SortedMap<WFiber,SortedSet<Integer>> getOccupiedResources(WLightpathRequest lp)
```
    Given a lightpath request, returns the optical slots occupied in the traversed fibers
    
    Parameters:
    
    lp - the lightpath request
    
    Returns:
    
    see above
  - getRegenerationPoints
```
public List<List<WFiber>> getRegenerationPoints(List<WFiber> seqFibers,
                                                double maxUnregeneratedDistanceInKm)
```
    Given a sequence of fibers (i.e. an intended path of a lightpath) and the maximum unreqenerated distance applicable for it (maximum km that can traverse without OEO regeneration), returns a partitioning of the input sequence of fibers into one or more OCh paths (List of WFiber), so that each OCh path has a length lower or equal than the maxUnregeneratedDistanceInKm, and the number of OChs is minimized.
    
    Parameters:
    
    seqFibers - see above
    
    maxUnregeneratedDistanceInKm - see above
    
    Returns:
    
    see above
  - isAllocatable
```
public boolean isAllocatable(Collection<WFiber> wdmLinks,
                             SortedSet<Integer> slotIds)
```
    Given a set of fibers and a set of optical slots, returns true if ALL the optical slots are idle in ALL the fibers
    
    Parameters:
    
    wdmLinks - the fibers
    
    slotIds - the optical slots
    
    Returns:
    
    see above
  - isAlreadyAccounted
```
public boolean isAlreadyAccounted(WLightpathUnregenerated lp)
```
    Returns true if the indicated lightpath is already accounted in this optical spectrm manager. This means that its occupation of optical slots in the traversed fibers is accounted for. Note that if the lightpath ocupation was introduced, and then its route is changed, the occupied resources should be updated by the user in optical spectrum manager.
    
    Parameters:
    
    lp - the lightpath
    
    Returns:
    
    see above
  - isOpticalSlotIdsValidAndIdle
```
public boolean isOpticalSlotIdsValidAndIdle(WFiber wdmLink,
                                            SortedSet<Integer> slotsIds)
```
    Indicates if the optical slots are usable (valid and idle) in the given fiber
    
    Parameters:
    
    wdmLink - see above
    
    slotsIds - see above
    
    Returns:
    
    see above
  - isSpectrumOccupationOk
```
public boolean isSpectrumOccupationOk()
```
    Returns true if the design is ok respect to spectrum occupation: no optical slot in any fiber is occupied by more than one lightpath, and no optical slot in a fiber is outside the valid range for that fiber
    
    Returns:
    
    see above
  - printReport
```
public String printReport()
```
    Prints a report with the occupation (for debugging pruposes)
    
    Returns:
    
    see above
  - releaseOccupation
```
public void releaseOccupation(WLightpathUnregenerated lp)
```
    Releases all the optical slots occupied for a given lightpath in this manager
    
    Parameters:
    
    lp - the lightpath
  - spectrumAssignment_firstFit
```
public Optional<SortedSet<Integer>> spectrumAssignment_firstFit(Collection<WFiber> seqFibers,
                                                                int numContiguousSlotsRequired,
                                                                Optional<Integer> minimumInitialSlotId)
```
    Searches for a first-fit assignment. Given a set of fibers to occupy, the number of contiguous optical slots needed, and (optionally) an initial optical slot (so optical slots of lower id are not consiedered), this method searches for the lowest-id contiguous range of slots that are available in all the indicated fibers. Note that if the set of fibers passes more than once in the same fiber, no assignment is possible, and Optional.empty is returned
    
    Parameters:
    
    seqFibers - see above
    
    numContiguousSlotsRequired - see above
    
    minimumInitialSlotId - see above
    
    Returns:
    
    see above. If no idle range is found, Optional.empty is returned.
  - spectrumAssignment_firstFitTwoRoutes
```
public Optional<Pair<SortedSet<Integer>,SortedSet<Integer>>> spectrumAssignment_firstFitTwoRoutes(Collection<WFiber> seqFibers_1,
                                                                                                  Collection<WFiber> seqFibers_2,
                                                                                                  int numContiguousSlotsRequired)
```
    Searches for a first-fit assignment for the two given paths, so optical slots can be different for each. Given two sets of fibers to occupy (paths), the number of contiguous optical slots needed in each, this method searches for the two lowest-id contiguous ranges of slots, so the first range is available in the first path, the second range is available in the second path. Note that if any path contains a fiber more than once, no allocation is possible. Note that if path1 and path2 have common fibers, the optical slots returned will always be disjoint.
    
    Parameters:
    
    seqFibers_1 - see above
    
    seqFibers_2 - see above
    
    numContiguousSlotsRequired - see above
    
    Returns:
    
    see above. If no idle range is found, Optional.empty is returned.

Class OpticalSpectrumManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

allocateOccupation

checkNetworkSlotOccupation

createFromRegularLps

getAvailableSlotIds

getIdleOpticalSlotIds

getMinimumAndMaximumValidSlotIdsInTheGrid

getOccupiedOpticalSlotIds

getOccupiedResources

getOccupiedResources

getRegenerationPoints

isAllocatable

isAlreadyAccounted

isOpticalSlotIdsValidAndIdle

isSpectrumOccupationOk

printReport

releaseOccupation

spectrumAssignment_firstFit

spectrumAssignment_firstFitTwoRoutes