WIpLink (net2plan-javadoc 0.6.0.1 API)

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

All Implemented Interfaces:

Comparable<WAbstractNetworkElement>
```
public class WIpLink
extends WAbstractNetworkElement
```
This class represents an unidirectional IP link. IP links can be realized by optical lightpaths or not. If yes, the IP link is said to be "coupled" to the lightpath, and then line rate of the IP link is that of the lightpath, and the IP link will be down whenever the lighptath is down

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`coupleToLightpathRequest(WLightpathRequest lpReq)` Couples this IP link to the provided lightpath request.
`void`	`decouple()` Decouples this IP link, if it is coupled to a lightpath
`WNode`	`getA()` Returns the IP link orgin node
`WNode`	`getB()` Returns the IP link destination node
`WIpLink`	`getBidirectionalPair()` If the IP link is part of a pair of IP bidirectional links, returns the opposite link pair.
`double`	`getCarriedTrafficGbps()` Returns the current IP traffic carried by the IP link in Gbps.
`WLightpathRequest`	`getCoupledLpRequest()` Returns the lightpath that this IP link is coupled to, or raises an exception if this IP link is not coupled
`double`	`getCurrentCapacityGbps()` Returns the current IP link capacity.
`double`	`getLengthIfNotCoupledInKm()` Returns the user-defined link length in km, which is assumed to be the valid one when the IP link is not coupled to a lightpath
`Link`	`getNe()` Returns the underlying Net2Plan object.
`double`	`getNominalCapacityGbps()` Returns the link nominal capacity in Gbps.
`double`	`getWorstCaseLengthInKm()` Returns the length of this link.
`double`	`getWorstCasePropagationDelayInMs()` Returns the propagation delay in ms of this link.
`boolean`	`isBidirectional()` Returns true if the IP link is part of a pair of IP bidirectional links
`boolean`	`isCoupledtoLpRequest()` Indicates if this IP link is coupled to a lighptath
`boolean`	`isVirtualLink()` Returns true is the IP links is virtual.
`void`	`setLengthIfNotCoupledInKm(double lengthInKm)` sets the user-defined link length in km, which is assumed to be the valid one when the IP link is not coupled to a 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
  - coupleToLightpathRequest
```
public void coupleToLightpathRequest(WLightpathRequest lpReq)
```
    Couples this IP link to the provided lightpath request. The lightpath line rate and the IP link nominal rate must be the same. If the link is already coupled, an exception is thrown
    
    Parameters:
    
    lpReq - see above
  - decouple
```
public void decouple()
```
    Decouples this IP link, if it is coupled to a lightpath
  - getA
```
public WNode getA()
```
    Returns the IP link orgin node
    
    Returns:
    
    see above
  - getB
```
public WNode getB()
```
    Returns the IP link destination node
    
    Returns:
    
    see above
  - getBidirectionalPair
```
public WIpLink getBidirectionalPair()
```
    If the IP link is part of a pair of IP bidirectional links, returns the opposite link pair. If not returns null.
    
    Returns:
    
    see above
  - getCarriedTrafficGbps
```
public double getCarriedTrafficGbps()
```
    Returns the current IP traffic carried by the IP link in Gbps.
    
    Returns:
    
    see above
  - getCoupledLpRequest
```
public WLightpathRequest getCoupledLpRequest()
```
    Returns the lightpath that this IP link is coupled to, or raises an exception if this IP link is not coupled
    
    Returns:
    
    see above
  - getCurrentCapacityGbps
```
public double getCurrentCapacityGbps()
```
    Returns the current IP link capacity. In general, the nominal capacity if the link is up, or zero if the link is down
    
    Returns:
    
    see above
  - getLengthIfNotCoupledInKm
```
public double getLengthIfNotCoupledInKm()
```
    Returns the user-defined link length in km, which is assumed to be the valid one when the IP link is not coupled to a lightpath
    
    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
  - getNominalCapacityGbps
```
public double getNominalCapacityGbps()
```
    Returns the link nominal capacity in Gbps. For IP links this is the nominal line rate of the underlying lightpath. For non-coupled IP links, this is a value user defined.
    
    Returns:
    
    see above
  - getWorstCaseLengthInKm
```
public double getWorstCaseLengthInKm()
```
    Returns the length of this link. If the link is NOT coupled, this is the user-defined length. If it is coupled, the length is the physical length of fibers traversed by the lightpath carrying this link. If the lightpath is 1+1 protected, the longest path length is returned.
    
    Returns:
    
    see above
  - getWorstCasePropagationDelayInMs
```
public double getWorstCasePropagationDelayInMs()
```
    Returns the propagation delay in ms of this link. If the link is NOT coupled, this is the user-defined length divided by the user defined propagatio speed. If it is coupled, the length is computed from the physical propagation delay of the fibers traversed by the lightpath carrying this link. If the lightpath is 1+1 protected, the longest path propagation delay is returned.
    
    Returns:
    
    see above
  - isBidirectional
```
public boolean isBidirectional()
```
    Returns true if the IP link is part of a pair of IP bidirectional links
    
    Returns:
    
    see above
  - isCoupledtoLpRequest
```
public boolean isCoupledtoLpRequest()
```
    Indicates if this IP link is coupled to a lighptath
    
    Returns:
    
    see above
  - isVirtualLink
```
public boolean isVirtualLink()
```
    Returns true is the IP links is virtual. This means that it starts or ends in a virtual node. Regular users do not need to use such links.
    
    Returns:
    
    see above
  - setLengthIfNotCoupledInKm
```
public void setLengthIfNotCoupledInKm(double lengthInKm)
```
    sets the user-defined link length in km, which is assumed to be the valid one when the IP link is not coupled to a lightpath
    
    Parameters:
    
    lengthInKm - see above
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WIpLink

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

coupleToLightpathRequest

decouple

getA

getB

getBidirectionalPair

getCarriedTrafficGbps

getCoupledLpRequest

getCurrentCapacityGbps

getLengthIfNotCoupledInKm

getNe

getNominalCapacityGbps

getWorstCaseLengthInKm

getWorstCasePropagationDelayInMs

isBidirectional

isCoupledtoLpRequest

isVirtualLink

setLengthIfNotCoupledInKm

toString