WLightpathUnregenerated (net2plan-javadoc 0.6.0.1 API)

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

All Implemented Interfaces:

Comparable<WAbstractNetworkElement>
```
public class WLightpathUnregenerated
extends WAbstractNetworkElement
```
This class represents a unidirectional lightpath of a given line rate, being a main path or backup path of a lightpath request. The lighptath is unregenerated, and has no wavelength conversion: the same set of optical slot are occupied in all the traversed fibers

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBackupLightpath(WLightpathUnregenerated backup)` Adds a backup lightpath to this lightpath
`WNode`	`getA()` The origin node of the lighptath, that must the origin node of the associated lightpath request
`WNode`	`getB()` The destination node of the lighptath, that must the destination node of the associated lightpath request
`double`	`getLengthInKm()` Returns the length in km of this lighptath, as the sum of the lengths of the traversed fibers
`WLightpathRequest`	`getLightpathRequest()` Returns the associated lightpath request
`String`	`getModulationId()` Returns the user-defined identifier of the modulation associated to the transponder realizing this lightpath
`Route`	`getNe()` Returns the underlying Net2Plan object.
`double`	`getNumberOccupiedSlotIds()` Returns the number of optical slots occupied by the lightpath
`SortedSet<Integer>`	`getOpticalSlotIds()` Returns the set of optical slots occupied in all the traversed fibers of this lightpath
`double`	`getPropagationDelayInMs()` Returns the propagation delay in ms of this lighptath, as the sum of the propagation delays of the traversed fibers
`List<WFiber>`	`getSeqFibers()` Returns the sequence of fibers traversed by this lp
`boolean`	`isBackupLightpath()` Indicates if this is a backup lightpath, of a main path in the same lightpath request
`boolean`	`isMainLightpathWithBackupRoutes()` Indicates if this is a main lightpath that has a backup lightpath in the same lightpath request
`boolean`	`isUp()` Indicates if this lightpath is up (does not traverse any failed fiber/node)
`void`	`remove()` Removes this lightpath
`void`	`removeBackupLightpath(WLightpathUnregenerated backup)` Removes a backup lightpath
`void`	`setAsBackupLightpath(WLightpathUnregenerated mainLp)` Sets this lightpath as a backup lightpath of other lightpath in this request
`void`	`setModulationId(String modulationId)` Sets the user-defined identifier of the modulation associated to the transponder realizing this lightpath
`void`	`setOpticalSlotIds(SortedSet<Integer> slotsIds)` Changes the set of optical slots occupied in all the traversed fibers of this lightpath
`void`	`setSeqFibers(List<WFiber> newSeqFibers)` Changes the sequence of fibers traversed by this lightpath
`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
  - addBackupLightpath
```
public void addBackupLightpath(WLightpathUnregenerated backup)
```
    Adds a backup lightpath to this lightpath
    
    Parameters:
    
    backup - see above
  - getA
```
public WNode getA()
```
    The origin node of the lighptath, that must the origin node of the associated lightpath request
    
    Returns:
    
    see above
  - getB
```
public WNode getB()
```
    The destination node of the lighptath, that must the destination node of the associated lightpath request
    
    Returns:
    
    see above
  - getLengthInKm
```
public double getLengthInKm()
```
    Returns the length in km of this lighptath, as the sum of the lengths of the traversed fibers
    
    Returns:
    
    see above
  - getLightpathRequest
```
public WLightpathRequest getLightpathRequest()
```
    Returns the associated lightpath request
    
    Returns:
    
    see above
  - getModulationId
```
public String getModulationId()
```
    Returns the user-defined identifier of the modulation associated to the transponder realizing this lightpath
    
    Returns:
    
    see above
  - getNe
```
public Route 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
  - getNumberOccupiedSlotIds
```
public double getNumberOccupiedSlotIds()
```
    Returns the number of optical slots occupied by the lightpath
    
    Returns:
    
    see above
  - getOpticalSlotIds
```
public SortedSet<Integer> getOpticalSlotIds()
```
    Returns the set of optical slots occupied in all the traversed fibers of this lightpath
    
    Returns:
    
    see above
  - getPropagationDelayInMs
```
public double getPropagationDelayInMs()
```
    Returns the propagation delay in ms of this lighptath, as the sum of the propagation delays of the traversed fibers
    
    Returns:
    
    see above
  - getSeqFibers
```
public List<WFiber> getSeqFibers()
```
    Returns the sequence of fibers traversed by this lp
    
    Returns:
    
    see above
  - isBackupLightpath
```
public boolean isBackupLightpath()
```
    Indicates if this is a backup lightpath, of a main path in the same lightpath request
    
    Returns:
    
    see above
  - isMainLightpathWithBackupRoutes
```
public boolean isMainLightpathWithBackupRoutes()
```
    Indicates if this is a main lightpath that has a backup lightpath in the same lightpath request
    
    Returns:
    
    see above
  - isUp
```
public boolean isUp()
```
    Indicates if this lightpath is up (does not traverse any failed fiber/node)
    
    Returns:
    
    see above
  - remove
```
public void remove()
```
    Removes this lightpath
  - removeBackupLightpath
```
public void removeBackupLightpath(WLightpathUnregenerated backup)
```
    Removes a backup lightpath
    
    Parameters:
    
    backup - see above
  - setAsBackupLightpath
```
public void setAsBackupLightpath(WLightpathUnregenerated mainLp)
```
    Sets this lightpath as a backup lightpath of other lightpath in this request
    
    Parameters:
    
    mainLp - see above
  - setModulationId
```
public void setModulationId(String modulationId)
```
    Sets the user-defined identifier of the modulation associated to the transponder realizing this lightpath
    
    Parameters:
    
    modulationId - see above
  - setOpticalSlotIds
```
public void setOpticalSlotIds(SortedSet<Integer> slotsIds)
```
    Changes the set of optical slots occupied in all the traversed fibers of this lightpath
    
    Parameters:
    
    slotsIds - see above
  - setSeqFibers
```
public void setSeqFibers(List<WFiber> newSeqFibers)
```
    Changes the sequence of fibers traversed by this lightpath
    
    Parameters:
    
    newSeqFibers - see above
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WLightpathUnregenerated

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

addBackupLightpath

getA

getB

getLengthInKm

getLightpathRequest

getModulationId

getNe

getNumberOccupiedSlotIds

getOpticalSlotIds

getPropagationDelayInMs

getSeqFibers

isBackupLightpath

isMainLightpathWithBackupRoutes

isUp

remove

removeBackupLightpath

setAsBackupLightpath

setModulationId

setOpticalSlotIds

setSeqFibers

toString