WVnfInstance (net2plan-javadoc 0.6.0.1 API)

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

All Implemented Interfaces:

Comparable<WAbstractNetworkElement>
```
public class WVnfInstance
extends WAbstractNetworkElement
```
An instance of this class is a VNF instance hosted in a node, of a given type, with a given capacity. The characteristics of the VNF instance are:
- Hosting node: the node where this VNF instance exists
- Type: The type of VNF
- Name: A user-defined string with the name of the VNF instance
- Processing time in ms: The processing time added to the traversing traffic.
- CPU, RAM, HD consumed: The amount of such resources of the node consumed by the VNF instance
- Capacity: measured as the amount of input Gbps that this VNF instance can process

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getCurrentCapacityInGbps()` Returns the current capacity of this VNF
`WNode`	`getHostingNode()` Returns the hosting node of the VNF instance
`String`	`getName()` Returns the user-defined name of this instance
`Resource`	`getNe()` Returns the underlying Net2Plan object.
`double`	`getOccupiedCapacityByTraversingRouteInGbps(WServiceChain sc)` Returns the VNF capacity occupied by a given service chain, or zero if (i) the service chain is down, (ii) the service chain is not traversing this VNF instance.
`double`	`getOccupiedCapacityInGbps()` Returns the VNF capacity (measured as Gbps of the traversing service chains, at the input of the VNF) that is currently consumed by the traversing service chains
`double`	`getOccupiedCpus()` Returns the amount of occupied CPUs by this VNf instance
`double`	`getOccupiedHdInGB()` Returns the amount of occupied hard-disk in Gbytes by this VNf instance
`double`	`getOccupiedRamInGB()` Returns the amount of occupied RAM in Gbytes by this VNf instance
`double`	`getProcessingTimeInMs()` Returns the processing time in ms added to the traversing traffic to account for the end-to-end latencies
`SortedSet<WServiceChainRequest>`	`getTraversingServiceChainRequests()` Returns the service chains requests that have at least one service chain that is traversing this VNF instance
`SortedSet<WServiceChain>`	`getTraversingServiceChains()` Returns the service chains that are traversing this VNF instance
`String`	`getType()` Returns the VNF type of this instance
`Optional<WVnfType>`	`getVnfType()` Returns the WVnfType object assigned to this instance type, if any
`void`	`remove()` Removes the current VNF instance, and all the service chains traversing it
`void`	`scaleVnfCapacityAndConsumptionToBaseInstanceMultiple()` Sets the capacity of this VNF instance as well as the CPU, RAM, HD consumption, so the VNF capacity is the minimum multiple of the capacity of the instance VNF type.
`void`	`setCapacityInGbpsOfInputTraffic(double newProcessingCapacityInGbps, double newOccupiedCpu, double newOccupiedRam, double newOccupiedHd)` Sets the VNF capacity and RAM/CPU/HD occupation of this instance
`void`	`setName(String name)` Sets the user-defined name for this instance
`void`	`setProcessingTimeInMs(double procTimeInMs)` Sets the processing time in ms added to the traversing traffic to account for the end-to-end latencies
`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
  - getCurrentCapacityInGbps
```
public double getCurrentCapacityInGbps()
```
    Returns the current capacity of this VNF
    
    Returns:
    
    see above
  - getHostingNode
```
public WNode getHostingNode()
```
    Returns the hosting node of the VNF instance
    
    Returns:
    
    see above
  - getName
```
public String getName()
```
    Returns the user-defined name of this instance
    
    Returns:
    
    see above
  - getNe
```
public Resource 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
  - getOccupiedCapacityByTraversingRouteInGbps
```
public double getOccupiedCapacityByTraversingRouteInGbps(WServiceChain sc)
```
    Returns the VNF capacity occupied by a given service chain, or zero if (i) the service chain is down, (ii) the service chain is not traversing this VNF instance. The VNF capacity occupied is the service chain traffic at the input of the VNF
    
    Parameters:
    
    sc - see above
    
    Returns:
    
    see above
  - getOccupiedCapacityInGbps
```
public double getOccupiedCapacityInGbps()
```
    Returns the VNF capacity (measured as Gbps of the traversing service chains, at the input of the VNF) that is currently consumed by the traversing service chains
    
    Returns:
    
    see above
  - getOccupiedCpus
```
public double getOccupiedCpus()
```
    Returns the amount of occupied CPUs by this VNf instance
    
    Returns:
    
    see above
  - getOccupiedHdInGB
```
public double getOccupiedHdInGB()
```
    Returns the amount of occupied hard-disk in Gbytes by this VNf instance
    
    Returns:
    
    see above
  - getOccupiedRamInGB
```
public double getOccupiedRamInGB()
```
    Returns the amount of occupied RAM in Gbytes by this VNf instance
    
    Returns:
    
    see above
  - getProcessingTimeInMs
```
public double getProcessingTimeInMs()
```
    Returns the processing time in ms added to the traversing traffic to account for the end-to-end latencies
    
    Returns:
    
    see above
  - getTraversingServiceChainRequests
```
public SortedSet<WServiceChainRequest> getTraversingServiceChainRequests()
```
    Returns the service chains requests that have at least one service chain that is traversing this VNF instance
    
    Returns:
    
    see above
  - getTraversingServiceChains
```
public SortedSet<WServiceChain> getTraversingServiceChains()
```
    Returns the service chains that are traversing this VNF instance
    
    Returns:
    
    see above
  - getType
```
public String getType()
```
    Returns the VNF type of this instance
    
    Returns:
    
    see above
  - getVnfType
```
public Optional<WVnfType> getVnfType()
```
    Returns the WVnfType object assigned to this instance type, if any
    
    Returns:
    
    see above
  - remove
```
public void remove()
```
    Removes the current VNF instance, and all the service chains traversing it
  - scaleVnfCapacityAndConsumptionToBaseInstanceMultiple
```
public void scaleVnfCapacityAndConsumptionToBaseInstanceMultiple()
```
    Sets the capacity of this VNF instance as well as the CPU, RAM, HD consumption, so the VNF capacity is the minimum multiple of the capacity of the instance VNF type. As an example, if the VNF type sets a per-instance capacity of 1 Gbps, consuming 1 CPU, 2 GBs RAM and 3 GBs HD, and the current VNF instance receives 1.5 GBps of traffic, the new VNF instance is scaled to have 2 Gbps of capacity, consuming 2 CPUs, 4 GBs RAM and 6 GBs HD.
  - setCapacityInGbpsOfInputTraffic
```
public void setCapacityInGbpsOfInputTraffic(double newProcessingCapacityInGbps,
                                            double newOccupiedCpu,
                                            double newOccupiedRam,
                                            double newOccupiedHd)
```
    Sets the VNF capacity and RAM/CPU/HD occupation of this instance
    
    Parameters:
    
    newProcessingCapacityInGbps - the new processing capacity of the VNF, measured as the maximum amount of Gbps considering the traffic of the traversing service chains, at the input of the VNF
    
    newOccupiedCpu - the amount of CPU occupied by this instance
    
    newOccupiedRam - the amount of RAM in GBytes occupied by this instance
    
    newOccupiedHd - the amount of hard disk in Gbytes occupied by this instance
  - setName
```
public void setName(String name)
```
    Sets the user-defined name for this instance
    
    Parameters:
    
    name - see above
  - setProcessingTimeInMs
```
public void setProcessingTimeInMs(double procTimeInMs)
```
    Sets the processing time in ms added to the traversing traffic to account for the end-to-end latencies
    
    Parameters:
    
    procTimeInMs - see above
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WVnfInstance

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getCurrentCapacityInGbps

getHostingNode

getName

getNe

getOccupiedCapacityByTraversingRouteInGbps

getOccupiedCapacityInGbps

getOccupiedCpus

getOccupiedHdInGB

getOccupiedRamInGB

getProcessingTimeInMs

getTraversingServiceChainRequests

getTraversingServiceChains

getType

getVnfType

remove

scaleVnfCapacityAndConsumptionToBaseInstanceMultiple

setCapacityInGbpsOfInputTraffic

setName

setProcessingTimeInMs

toString