WDMUtils.TransponderTypesInfo (net2plan-javadoc 0.6.0.1 API)

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

Enclosing class:

WDMUtils
```
public static class WDMUtils.TransponderTypesInfo
extends Object
```
This class is devoted to give easy access to the transponders information provided by the user in the typical user-defined parameters transponderTypesInfo.
In such parameters, the user can establish the set of available transponder types for an algorithm, as a String. Transpoder types separated by \";\" . Each type is characterized by the space-separated values: (i) Line rate in Gbps, (ii) cost of the transponder, (iii) number of slots occupied in each traversed fiber, (iv) optical reach in km (a non-positive number means no reach limit), (v) cost of the optical signal regenerator (regenerators do NOT make wavelength conversion ; if negative, regeneration is not possible).

Constructor Summary

Constructors
Constructor and Description
`TransponderTypesInfo(String initializationString)` Constructor to initialize the available transponder types object from the user's input parameter string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getCost(int tpType)` Returns the cost of the transponder of the given type
`double`	`getLineRateGbps(int tpType)` Returns the line rate in Gbps of a transponder type
`double`	`getMaxOpticalReachKm()` The maximum optical reach among all the transponders.
`int`	`getNumSlots(int tpType)` Returns the number of frequency slots occupied in all the traversed fibers by the lightpaths initiated in this transponder
`int`	`getNumTypes()` Returns the number of transponder types defined
`double`	`getOpticalReachKm(int tpType)` Returns the maximum optical reach without signal regeneration of this transponder type.
`double`	`getRegeneratorCost(int tpType)` Returns the cost of a signal regenerator for the lightpaths of the transponders of the given type.
`double[]`	`getVectorCosts()` Returns a vector with one element per transponder type, and its cost
`double[]`	`getVectorLineRates()` Returns a vector with one element per transponder type, with its line rate and Gbps
`int[]`	`getVectorNumSlots()` Returns a vector with one elements per transponder type, with its number of occupied frequency slots
`double[]`	`getVectorOpticalReachesKm()` Returns a vector with one element per transponder type, with its unregenrated optical reach
`double[]`	`getVectorRegeneratorCosts()` Returns a vector with one element per transponder type, with its cost of a signal regenerator as returned by the `getRegeneratorCost` method.
`boolean`	`isFixedGrid()` Returns true if all the transponders defined have a number of occupied slots equal to one, and false otherwise.
`boolean`	`isFixedLineRate()` Returns true if all the transponder types defined have the same line rate.
`boolean`	`isOpticalRegenerationPossible(int tpType)` Returns true if signal regeneration is allowed for the lightpaths with the given transponder type.
`boolean`	`isValidLineRateForAtLeastOneType(double lineRateGbps)` Returns true if the given line rate is the rate of at least one transponder type

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

- Constructor Detail
  - TransponderTypesInfo
```
public TransponderTypesInfo(String initializationString)
```
    Constructor to initialize the available transponder types object from the user's input parameter string.
    
    Parameters:
    
    initializationString - The initialization string as comes from the user
- Method Detail
  - getCost
```
public double getCost(int tpType)
```
    Returns the cost of the transponder of the given type
    
    Parameters:
    
    tpType - the type
    
    Returns:
    
    the cost
  - getLineRateGbps
```
public double getLineRateGbps(int tpType)
```
    Returns the line rate in Gbps of a transponder type
    
    Parameters:
    
    tpType - the type
    
    Returns:
    
    the line rate in Gbps
  - getMaxOpticalReachKm
```
public double getMaxOpticalReachKm()
```
    The maximum optical reach among all the transponders. If a transponder can be regenerated, its optical reach is Double.MAX_VALUE
    
    Returns:
    
    see above
  - getNumSlots
```
public int getNumSlots(int tpType)
```
    Returns the number of frequency slots occupied in all the traversed fibers by the lightpaths initiated in this transponder
    
    Parameters:
    
    tpType - the type
    
    Returns:
    
    the number of slots
  - getNumTypes
```
public int getNumTypes()
```
    Returns the number of transponder types defined
    
    Returns:
    
    the number
  - getOpticalReachKm
```
public double getOpticalReachKm(int tpType)
```
    Returns the maximum optical reach without signal regeneration of this transponder type.
    
    Parameters:
    
    tpType - the type
    
    Returns:
    
    the maximum unregenerated optical reach in km
  - getRegeneratorCost
```
public double getRegeneratorCost(int tpType)
```
    Returns the cost of a signal regenerator for the lightpaths of the transponders of the given type. If the user defined this cost with a negative number to reflect that no regeneratios is possible, the same number is returned here.
    
    Parameters:
    
    tpType - the type
    
    Returns:
    
    the cost
  - getVectorCosts
```
public double[] getVectorCosts()
```
    Returns a vector with one element per transponder type, and its cost
    
    Returns:
    
    the vector (not a copy, changes in the vector can produce anomaloous operation of this class)
  - getVectorLineRates
```
public double[] getVectorLineRates()
```
    Returns a vector with one element per transponder type, with its line rate and Gbps
    
    Returns:
    
    the vector (not a copy, changes in the vector can produce anomaloous operation of this class)
  - getVectorNumSlots
```
public int[] getVectorNumSlots()
```
    Returns a vector with one elements per transponder type, with its number of occupied frequency slots
    
    Returns:
    
    the vector (not a copy, changes in the vector can produce anomaloous operation of this class)
  - getVectorOpticalReachesKm
```
public double[] getVectorOpticalReachesKm()
```
    Returns a vector with one element per transponder type, with its unregenrated optical reach
    
    Returns:
    
    the vector (not a copy, changes in the vector can produce anomaloous operation of this class)
  - getVectorRegeneratorCosts
```
public double[] getVectorRegeneratorCosts()
```
    Returns a vector with one element per transponder type, with its cost of a signal regenerator as returned by the getRegeneratorCost method.
    
    Returns:
    
    the vector (not a copy, changes in the vector can produce anomaloous operation of this class)
  - isFixedGrid
```
public boolean isFixedGrid()
```
    Returns true if all the transponders defined have a number of occupied slots equal to one, and false otherwise. The former case corresponds to a fixed grid network, the latter a flexi-grid case
    
    Returns:
    
    see above
  - isFixedLineRate
```
public boolean isFixedLineRate()
```
    Returns true if all the transponder types defined have the same line rate.
    
    Returns:
    
    see above
  - isOpticalRegenerationPossible
```
public boolean isOpticalRegenerationPossible(int tpType)
```
    Returns true if signal regeneration is allowed for the lightpaths with the given transponder type. This occurs when the user has defined a non-negative cost for the optical signal regenerators.
    
    Parameters:
    
    tpType - the type
    
    Returns:
    
    see above
  - isValidLineRateForAtLeastOneType
```
public boolean isValidLineRateForAtLeastOneType(double lineRateGbps)
```
    Returns true if the given line rate is the rate of at least one transponder type
    
    Parameters:
    
    lineRateGbps - the rate
    
    Returns:
    
    see above

Class WDMUtils.TransponderTypesInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransponderTypesInfo

Method Detail

getCost

getLineRateGbps

getMaxOpticalReachKm

getNumSlots

getNumTypes

getOpticalReachKm

getRegeneratorCost

getVectorCosts

getVectorLineRates

getVectorNumSlots

getVectorOpticalReachesKm

getVectorRegeneratorCosts

isFixedGrid

isFixedLineRate

isOpticalRegenerationPossible

isValidLineRateForAtLeastOneType