WFiber (net2plan-javadoc 0.6.0.1 API)

java.lang.Object
- com.net2plan.research.niw.networkModel.WAbstractNetworkElement
- - com.net2plan.research.niw.networkModel.WFiber

All Implemented Interfaces:

Comparable<WAbstractNetworkElement>
```
public class WFiber
extends WAbstractNetworkElement
```
Author:

Pablo

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WNode`	`getA()` Returns the origin node of the link
`List<Double>`	`getAmplifierGains_dB()` Get gains of the amplifiers traversed, in the same order as they are traversed
`List<Double>`	`getAmplifierNoiseFactor_dB()` Gets the list of amplifier noise factors in dB
`List<Double>`	`getAmplifierPmd_ps()` Gets the PMD in ps added to the signal by the amplifier
`List<Double>`	`getAmplifierPositionsKmFromOrigin_km()` Gets the list of amplifier positions, measured as km from the link start
`String`	`getArbitraryParamString()` Each element can be associated a user defined param string.
`double`	`getAttenuationCoefficient_dbPerKm()` Returns the fiber user-defined attenutation coefficient in dB per km
`WNode`	`getB()` Returns the destination node of the link
`WFiber`	`getBidirectionalPair()` If this fiber is part of a bidirectional fiber pair, returns the opposite fiber.
`double`	`getChromaticDispersionCoeff_psPerNmKm()` Returns the fiber chromatic dispersion coefficient, in ps per nm / km
`double`	`getLengthInKm()` Returns the link length in km, as defined by the user
`Pair<Integer,Integer>`	`getMinMaxValidSlotId()` Returns the minimum and maximum valid optical slot ids as defined by the user
`Link`	`getNe()` Returns the underlying Net2Plan object.
`int`	`getNumberOfOpticalLineAmplifiersTraversed()` Returns the current number of optical line amplifiers traversed
`int`	`getNumberOfValidOpticalChannels()` Returns the total number of valid optica slots in this fiber, as defined by the user
`double`	`getPmdLinkDesignValueCoeff_psPerSqrtKm()` Returns the PMD fiber design value in ps per square root of km
`SortedSet<WLightpathRequest>`	`getTraversingLpRequestsInAtLeastOneLp()` Returns the set of lightpaths that traverse this fiber
`SortedSet<WLightpathUnregenerated>`	`getTraversingLps()` Returns the set of lightpaths that traverse this fiber.
`SortedSet<Integer>`	`getValidOpticalSlotIds()` Returns the set of all the optical slot ids usable in the fiber, according to the valid optical slot ranges defined by the user
`List<Integer>`	`getValidOpticalSlotRanges()` Returns the valid optical slot ranges as defined by the user
`boolean`	`isBidirectional()` Returns true if the fiber is part of a bidirectional fiber pair
`boolean`	`isUp()` Returns true is the fiber is up, false otherwise
`void`	`remove()` Remove this fiber
`void`	`setAmplifiersTraversed_dB(List<Double> positionFromLinkOrigin_km, List<Double> gains_db, List<Double> noiseFactors_dB, List<Double> pmd_ps)` Sets the traversed amplifiers information
`void`	`setArbitraryParamString(String s)` Each element can be associated a user defined param string.
`void`	`setAsDown()` Sets this fiber as down (failed).
`void`	`setAsUp()` Sets this fiber as up (not failed)
`void`	`setAttenuationCoefficient_dbPerKm(double attenuationCoef_dbPerKm)` Sets the fiber attenuation coefficient in dB per km
`void`	`setChromaticDispersionCoeff_psPerNmKm(double cdCoeff_psPerNmKm)` Sets the fiber chromatic dispersion coefficient, in ps per nm / km
`void`	`setLenghtInKm(double lenghtInKm)` Sets the link length in km
`void`	`setPmdLinkDesignValueCoeff_psPerSqrtKm(double pmdCoeff_psPerSqrKm)` Sets the PMD fiber design value in ps per square root of km
`void`	`setValidOpticalSlotRanges(List<Integer> listInitialEndSlotRanges)` Sets the slot ranges that this fiber can propagate.
`String`	`toString()`

Methods inherited from class com.net2plan.research.niw.networkModel.WAbstractNetworkElement
compareTo, equals, getAsFiber, getAsIpLayer, getAsIpLink, getAsLightpathRequest, getAsLightpathUnregenerated, getAsNode, getAsServiceChain, getAsServiceChainRequest, getAsVnfInstance, getAsWdmLayer, getId, getNet, getNetPlan, isFiber, isLayerIp, isLayerWdm, isLightpathRequest, isLightpathUnregenerated, isNode, isServiceChain, isServiceChainRequest, isVnfInstance, isWIpLink, wasRemoved

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

- Method Detail
  - getA
```
public WNode getA()
```
    Returns the origin node of the link
    
    Returns:
    
    see above
  - getAmplifierGains_dB
```
public List<Double> getAmplifierGains_dB()
```
    Get gains of the amplifiers traversed, in the same order as they are traversed
    
    Returns:
    
    see above
  - getAmplifierNoiseFactor_dB
```
public List<Double> getAmplifierNoiseFactor_dB()
```
    Gets the list of amplifier noise factors in dB
    
    Returns:
    
    see above
  - getAmplifierPmd_ps
```
public List<Double> getAmplifierPmd_ps()
```
    Gets the PMD in ps added to the signal by the amplifier
    
    Returns:
    
    see above
  - getAmplifierPositionsKmFromOrigin_km
```
public List<Double> getAmplifierPositionsKmFromOrigin_km()
```
    Gets the list of amplifier positions, measured as km from the link start
    
    Returns:
    
    see above
  - getArbitraryParamString
```
public String getArbitraryParamString()
```
    Each element can be associated a user defined param string. This method gets such string
    
    Returns:
    
    see above
  - getAttenuationCoefficient_dbPerKm
```
public double getAttenuationCoefficient_dbPerKm()
```
    Returns the fiber user-defined attenutation coefficient in dB per km
    
    Returns:
    
    see above
  - getB
```
public WNode getB()
```
    Returns the destination node of the link
    
    Returns:
    
    see above
  - getBidirectionalPair
```
public WFiber getBidirectionalPair()
```
    If this fiber is part of a bidirectional fiber pair, returns the opposite fiber. If not returns null
    
    Returns:
    
    see above
  - getChromaticDispersionCoeff_psPerNmKm
```
public double getChromaticDispersionCoeff_psPerNmKm()
```
    Returns the fiber chromatic dispersion coefficient, in ps per nm / km
    
    Returns:
    
    see above
  - getLengthInKm
```
public double getLengthInKm()
```
    Returns the link length in km, as defined by the user
    
    Returns:
    
    see above
  - getMinMaxValidSlotId
```
public Pair<Integer,Integer> getMinMaxValidSlotId()
```
    Returns the minimum and maximum valid optical slot ids as defined by the user
    
    Returns:
    
    see above
  - getNe
```
public Link getNe()
```
    Description copied from class: WAbstractNetworkElement
    
    Returns the underlying Net2Plan object. Users should NOT modify or even read this object, since all manipulations should be made through the provided methods in he library. This method is just provided for debugging for those users who really know what they are doing
    
    Specified by:
    
    getNe in class WAbstractNetworkElement
    
    Returns:
    
    see above
  - getNumberOfOpticalLineAmplifiersTraversed
```
public int getNumberOfOpticalLineAmplifiersTraversed()
```
    Returns the current number of optical line amplifiers traversed
    
    Returns:
    
    see above
  - getNumberOfValidOpticalChannels
```
public int getNumberOfValidOpticalChannels()
```
    Returns the total number of valid optica slots in this fiber, as defined by the user
    
    Returns:
    
    see above
  - getPmdLinkDesignValueCoeff_psPerSqrtKm
```
public double getPmdLinkDesignValueCoeff_psPerSqrtKm()
```
    Returns the PMD fiber design value in ps per square root of km
    
    Returns:
    
    see above
  - getTraversingLpRequestsInAtLeastOneLp
```
public SortedSet<WLightpathRequest> getTraversingLpRequestsInAtLeastOneLp()
```
    Returns the set of lightpaths that traverse this fiber
    
    Returns:
    
    see above
  - getTraversingLps
```
public SortedSet<WLightpathUnregenerated> getTraversingLps()
```
    Returns the set of lightpaths that traverse this fiber.
    
    Returns:
    
    see above
  - getValidOpticalSlotIds
```
public final SortedSet<Integer> getValidOpticalSlotIds()
```
    Returns the set of all the optical slot ids usable in the fiber, according to the valid optical slot ranges defined by the user
    
    Returns:
    
    see above
  - getValidOpticalSlotRanges
```
public final List<Integer> getValidOpticalSlotRanges()
```
    Returns the valid optical slot ranges as defined by the user
    
    Returns:
    
    see above
  - isBidirectional
```
public boolean isBidirectional()
```
    Returns true if the fiber is part of a bidirectional fiber pair
    
    Returns:
    
    see above
  - isUp
```
public boolean isUp()
```
    Returns true is the fiber is up, false otherwise
    
    Returns:
    
    see above
  - remove
```
public void remove()
```
    Remove this fiber
  - setAmplifiersTraversed_dB
```
public void setAmplifiersTraversed_dB(List<Double> positionFromLinkOrigin_km,
                                      List<Double> gains_db,
                                      List<Double> noiseFactors_dB,
                                      List<Double> pmd_ps)
```
    Sets the traversed amplifiers information
    
    Parameters:
    
    positionFromLinkOrigin_km - list of positions in km, counting from the link origin
    
    gains_db - for each amplifier, the gain in dB applied
    
    noiseFactors_dB - for each amplifier, the ASE noise factor added
    
    pmd_ps - for each amplifier, the PMD factor applied
  - setArbitraryParamString
```
public void setArbitraryParamString(String s)
```
    Each element can be associated a user defined param string. This method sets such string
    
    Parameters:
    
    s - the string
  - setAsDown
```
public void setAsDown()
```
    Sets this fiber as down (failed). Traversing lighptaths will be set to failed also
  - setAsUp
```
public void setAsUp()
```
    Sets this fiber as up (not failed)
  - setAttenuationCoefficient_dbPerKm
```
public void setAttenuationCoefficient_dbPerKm(double attenuationCoef_dbPerKm)
```
    Sets the fiber attenuation coefficient in dB per km
    
    Parameters:
    
    attenuationCoef_dbPerKm - see above
  - setChromaticDispersionCoeff_psPerNmKm
```
public void setChromaticDispersionCoeff_psPerNmKm(double cdCoeff_psPerNmKm)
```
    Sets the fiber chromatic dispersion coefficient, in ps per nm / km
    
    Parameters:
    
    cdCoeff_psPerNmKm - see above
  - setLenghtInKm
```
public void setLenghtInKm(double lenghtInKm)
```
    Sets the link length in km
    
    Parameters:
    
    lenghtInKm - see above
  - setPmdLinkDesignValueCoeff_psPerSqrtKm
```
public void setPmdLinkDesignValueCoeff_psPerSqrtKm(double pmdCoeff_psPerSqrKm)
```
    Sets the PMD fiber design value in ps per square root of km
    
    Parameters:
    
    pmdCoeff_psPerSqrKm - see above
  - setValidOpticalSlotRanges
```
public final void setValidOpticalSlotRanges(List<Integer> listInitialEndSlotRanges)
```
    Sets the slot ranges that this fiber can propagate. This is a list of 2*K elements, being K the number of contiguous ranges. First number in a range is the id of the initial optical slot, second number is the end. For instance, a range setting [0 300 320 360] means that the fiber is able to propagate the optical slots from 0 to 300 both included, and from 320 to 360 both included.
    
    Parameters:
    
    listInitialEndSlotRanges - see above
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WFiber

Method Summary

Methods inherited from class com.net2plan.research.niw.networkModel.WAbstractNetworkElement

Methods inherited from class java.lang.Object

Method Detail

getA

getAmplifierGains_dB

getAmplifierNoiseFactor_dB

getAmplifierPmd_ps

getAmplifierPositionsKmFromOrigin_km

getArbitraryParamString

getAttenuationCoefficient_dbPerKm

getB

getBidirectionalPair

getChromaticDispersionCoeff_psPerNmKm

getLengthInKm

getMinMaxValidSlotId

getNe

getNumberOfOpticalLineAmplifiersTraversed

getNumberOfValidOpticalChannels

getPmdLinkDesignValueCoeff_psPerSqrtKm

getTraversingLpRequestsInAtLeastOneLp

getTraversingLps

getValidOpticalSlotIds

getValidOpticalSlotRanges

isBidirectional

isUp

remove

setAmplifiersTraversed_dB

setArbitraryParamString

setAsDown

setAsUp

setAttenuationCoefficient_dbPerKm

setChromaticDispersionCoeff_psPerNmKm

setLenghtInKm

setPmdLinkDesignValueCoeff_psPerSqrtKm

setValidOpticalSlotRanges

toString