WLightpathRequest (net2plan-javadoc 0.6.0.1 API)

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

All Implemented Interfaces:

Comparable<WAbstractNetworkElement>
```
public class WLightpathRequest
extends WAbstractNetworkElement
```
This class represents a request to establish a unidirectional lightpath between two nodes, for a given line rate. The lightpath request can be blocked (no lighptaths assigned), or relalizaed by one or two (1+1) lightpaths.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WLightpathUnregenerated`	`addLightpathUnregenerated(List<WFiber> sequenceFibers, SortedSet<Integer> occupiedSlots, boolean isBackupRoute)` Adds a lightpath realizing this lightpath request.
`void`	`coupleToIpLink(WIpLink ipLink)` Couples this lightpath request to an IP link
`void`	`decouple()` Decouples this lightpath request to the IP link it was coupled to, if any
`WNode`	`getA()` The lightpath request origin node
`WNode`	`getB()` The lightpath request destination node
`WLightpathRequest`	`getBidirectionalPair()` If the lightpath is part of a bidirectional pair, returns the opposite lightpath request, if not returns null
`WIpLink`	`getCoupledIpLink()` Gets the coupled IP links, or raises an exception if none
`double`	`getCurrentCapacityGbps()` Return the current lightpath request capacity: its nominal line rate if up, or zero if down
`List<WLightpathUnregenerated>`	`getLightpaths()` Returns the set of lightpaths realizing this request.
`double`	`getLineRateGbps()` Returns the line rate of the lighptath request in Gbps
`Demand`	`getNe()` Returns the underlying Net2Plan object.
`double`	`getWorstCaseLengthInKm()` Returns the length of this lightpath request, as the physical length of fibers traversed by the lightpaths carrying this request.
`double`	`getWorstCasePropagationDelayMs()` Returns the propagation delay in ms of this lightpath request, as the propagation delay of fibers traversed by the lightpaths carrying this request.
`boolean`	`hasLightpathsAssigned()` Indicates if this lighptath request has lightpaths assigned
`boolean`	`is11Protected()` Indicates if the lighptath request is supported by a 1+1 setting of two lightpaths
`boolean`	`isBidirectional()` Indicates if the lightpath is part of a bidirectinal pair of lighptaths
`boolean`	`isBlocked()` Indicates if the request is blocked, meaning (i) has no lightpaths assigned, or (ii) assigned lightpaths are all down
`boolean`	`isCoupledToIpLink()` Indicates if the lightpath is coupled to an IP link
`boolean`	`isToBe11Protected()` Indicates if the user has requested this lightpath request to be realized by a 1+1 setting
`void`	`remove()` Removes this lightpath request.
`void`	`setIsToBe11Protected(boolean isToBe11Protected)` Sets if this lightpath request has to be realized by a 1+1 setting or not
`void`	`setLineRateGbps(double lineRateGbps)` Sets the line rate of the lighptath request in Gbps
`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
  - addLightpathUnregenerated
```
public WLightpathUnregenerated addLightpathUnregenerated(List<WFiber> sequenceFibers,
                                                         SortedSet<Integer> occupiedSlots,
                                                         boolean isBackupRoute)
```
    Adds a lightpath realizing this lightpath request. A demand can be assigned at most two lightpaths, one main and one backup.
    
    Parameters:
    
    sequenceFibers - the sequence of traversed fibers
    
    occupiedSlots - the setof occupied slots
    
    isBackupRoute - indicates if this is a backup route (needs a main lightpath to be already added to the request).
    
    Returns:
    
    see above
  - coupleToIpLink
```
public void coupleToIpLink(WIpLink ipLink)
```
    Couples this lightpath request to an IP link
    
    Parameters:
    
    ipLink - see above
  - decouple
```
public void decouple()
```
    Decouples this lightpath request to the IP link it was coupled to, if any
  - getA
```
public WNode getA()
```
    The lightpath request origin node
    
    Returns:
    
    see above
  - getB
```
public WNode getB()
```
    The lightpath request destination node
    
    Returns:
    
    see above
  - getBidirectionalPair
```
public WLightpathRequest getBidirectionalPair()
```
    If the lightpath is part of a bidirectional pair, returns the opposite lightpath request, if not returns null
    
    Returns:
    
    see above
  - getCoupledIpLink
```
public WIpLink getCoupledIpLink()
```
    Gets the coupled IP links, or raises an exception if none
    
    Returns:
    
    see above
  - getCurrentCapacityGbps
```
public double getCurrentCapacityGbps()
```
    Return the current lightpath request capacity: its nominal line rate if up, or zero if down
    
    Returns:
    
    see above
  - getLightpaths
```
public List<WLightpathUnregenerated> getLightpaths()
```
    Returns the set of lightpaths realizing this request. Typically one in unprotected ligtpaths, two in 1+1 settings
    
    Returns:
    
    see above
  - getLineRateGbps
```
public double getLineRateGbps()
```
    Returns the line rate of the lighptath request in Gbps
    
    Returns:
    
    see above
  - getNe
```
public Demand 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
  - getWorstCaseLengthInKm
```
public double getWorstCaseLengthInKm()
```
    Returns the length of this lightpath request, as the physical length of fibers traversed by the lightpaths carrying this request. If the lightpath is 1+1 protected, the longest path length is returned. If the request has assigned no lighptaths, Double.MAX_VALUE is returned.
    
    Returns:
    
    see above
  - getWorstCasePropagationDelayMs
```
public double getWorstCasePropagationDelayMs()
```
    Returns the propagation delay in ms of this lightpath request, as the propagation delay of fibers traversed by the lightpaths carrying this request. If the lightpath is 1+1 protected, the longest path length is returned. If the request has assigned no lighptaths, Double.MAX_VALUE is returned.
    
    Returns:
    
    see above
  - hasLightpathsAssigned
```
public boolean hasLightpathsAssigned()
```
    Indicates if this lighptath request has lightpaths assigned
    
    Returns:
    
    see above
  - is11Protected
```
public boolean is11Protected()
```
    Indicates if the lighptath request is supported by a 1+1 setting of two lightpaths
    
    Returns:
    
    see above
  - isBidirectional
```
public boolean isBidirectional()
```
    Indicates if the lightpath is part of a bidirectinal pair of lighptaths
    
    Returns:
    
    see above
  - isBlocked
```
public boolean isBlocked()
```
    Indicates if the request is blocked, meaning (i) has no lightpaths assigned, or (ii) assigned lightpaths are all down
    
    Returns:
    
    see above
  - isCoupledToIpLink
```
public boolean isCoupledToIpLink()
```
    Indicates if the lightpath is coupled to an IP link
    
    Returns:
    
    see above
  - isToBe11Protected
```
public boolean isToBe11Protected()
```
    Indicates if the user has requested this lightpath request to be realized by a 1+1 setting
    
    Returns:
    
    see above
  - remove
```
public void remove()
```
    Removes this lightpath request. This automatically removes any lightpath realizing this request.
  - setIsToBe11Protected
```
public void setIsToBe11Protected(boolean isToBe11Protected)
```
    Sets if this lightpath request has to be realized by a 1+1 setting or not
    
    Parameters:
    
    isToBe11Protected - see above
  - setLineRateGbps
```
public void setLineRateGbps(double lineRateGbps)
```
    Sets the line rate of the lighptath request in Gbps
    
    Parameters:
    
    lineRateGbps - see above
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WLightpathRequest

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

addLightpathUnregenerated

coupleToIpLink

decouple

getA

getB

getBidirectionalPair

getCoupledIpLink

getCurrentCapacityGbps

getLightpaths

getLineRateGbps

getNe

getWorstCaseLengthInKm

getWorstCasePropagationDelayMs

hasLightpathsAssigned

is11Protected

isBidirectional

isBlocked

isCoupledToIpLink

isToBe11Protected

remove

setIsToBe11Protected

setLineRateGbps

toString