WNode (net2plan-javadoc 0.6.0.1 API)

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

All Implemented Interfaces:

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

Pablo

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SortedSet<WVnfInstance>`	`getAllVnfInstances()` Returns all the VNF instances in this node, of any type
`String`	`getArbitraryParamString()`
`SortedSet<WFiber>`	`getIncomingFibers()` Returns the set of incoming fibers to the node
`SortedSet<WIpLink>`	`getIncomingIpLinks()` Returns the set of incoming IP links to the node
`SortedSet<WLightpathRequest>`	`getIncomingLigtpathRequests()` Returns the set of incoming lightpath requests to the node
`SortedSet<WLightpathUnregenerated>`	`getIncomingLigtpaths()` Returns the set of incoming lightpaths to the node
`SortedSet<WServiceChainRequest>`	`getIncomingServiceChainRequests()` Returns the set of incoming service chain requests of the node: those which have the node as a potential end node
`SortedSet<WServiceChain>`	`getIncomingServiceChains()` Returns the set of incoming service chains to the node, including those ended in a VNF in the node
`SortedSet<WLightpathUnregenerated>`	`getInOutOrTraversingLigtpaths()` Returns the set of incoming, outgoing and traversing lightpaths to the node
`SortedSet<WServiceChain>`	`getInOutOrTraversingServiceChains()` Returns the set of incoming, outgoing and traversing service chains to the node.
`String`	`getName()` Returns the node name, which must be unique among all the nodes
`Node`	`getNe()` Returns the underlying Net2Plan object.
`Point2D`	`getNodePositionXY()` Returns the (X,Y) node position
`double`	`getOccupiedCpus()` Returns the current number of occupied CPUs by the instantiated VNFs
`double`	`getOccupiedHdGB()` Returns the current amount of occupied hard-disk (in giga bytes) by the instantiated VNFs
`double`	`getOccupiedRamGB()` Returns the current amount of occupied RAM (in giga bytes) by the instantiated VNFs
`SortedSet<WFiber>`	`getOutgoingFibers()` Returns the set of outgoing fibers of the node
`SortedSet<WIpLink>`	`getOutgoingIpLinks()` Returns the set of outgoing IP links of the node
`SortedSet<WLightpathRequest>`	`getOutgoingLigtpathRequests()` Returns the set of outgoing lightpath requests of the node
`SortedSet<WLightpathUnregenerated>`	`getOutgoingLigtpaths()` Returns the set of outgoing lightpaths of the node
`SortedSet<WServiceChainRequest>`	`getOutgoingServiceChainRequests()` Returns the set of outgoing service chain requests of the node: those which have the node as a potential injection node
`SortedSet<WServiceChain>`	`getOutgoingServiceChains()` Returns the set of outgoing service chains of the node, including those starting in a VNF in the node
`double`	`getPopulation()` Returns the user-defined node population
`double`	`getTotalHdGB()` Returns the total hard disk size (in GBytes) available in the node for instantiation of VNFs
`double`	`getTotalNumCpus()` Returns the number of CPUs available in the node for instantiation of VNFs
`double`	`getTotalRamGB()` Returns the total RAM (in GBytes) available in the node for instantiation of VNFs
`String`	`getType()` Returns the user-defined node type
`SortedSet<WVnfInstance>`	`getVnfInstances(String type)` Returns all the VNF instances in this node, of the given type
`boolean`	`isConnectedToNetworkCore()` Returns if this node is connected to a core node (core nodes are not in the design)
`boolean`	`isUp()` Indicates if the node is up or down (failed)
`void`	`remove()` Removes this node, and all the ending and initiated links, or traversing lightpaths or service chains
`void`	`setArbitraryParamString(String s)`
`void`	`setAsDown()` Sets the node as down (failed), so traversing IP links or lightpaths become down
`void`	`setAsUp()` Sets the node as up (working, non-failed)
`void`	`setIsConnectedToNetworkCore(boolean isConnectedToCore)` Sets if this node is assumed to be connected to a core node (core nodes are not in the design)
`void`	`setName(String name)` Sets the node name, which must be unique among all the nodes
`void`	`setNodePositionXY(Point2D position)` Sets the (X,Y) node position
`void`	`setPoputlation(double population)` Sets the user-defined node population
`void`	`setTotalHdGB(double totalHdGB)` Sets the total hard disk size (in GBytes) available in the node for instantiation of VNFs
`void`	`setTotalNumCpus(double totalNumCpus)` Sets the number of CPUs available in the node for instantiation of VNFs
`void`	`setTotalRamGB(double totalRamGB)` Sets the total RAM (in GBytes) available in the node for instantiation of VNFs
`void`	`setType(String type)` Sets the user-defined node type
`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
  - getAllVnfInstances
```
public SortedSet<WVnfInstance> getAllVnfInstances()
```
    Returns all the VNF instances in this node, of any type
    
    Returns:
    
    see above
  - getArbitraryParamString
```
public String getArbitraryParamString()
```
  - getIncomingFibers
```
public SortedSet<WFiber> getIncomingFibers()
```
    Returns the set of incoming fibers to the node
    
    Returns:
    
    see above
  - getIncomingIpLinks
```
public SortedSet<WIpLink> getIncomingIpLinks()
```
    Returns the set of incoming IP links to the node
    
    Returns:
    
    see above
  - getIncomingLigtpathRequests
```
public SortedSet<WLightpathRequest> getIncomingLigtpathRequests()
```
    Returns the set of incoming lightpath requests to the node
    
    Returns:
    
    see above
  - getIncomingLigtpaths
```
public SortedSet<WLightpathUnregenerated> getIncomingLigtpaths()
```
    Returns the set of incoming lightpaths to the node
    
    Returns:
    
    see above
  - getIncomingServiceChainRequests
```
public SortedSet<WServiceChainRequest> getIncomingServiceChainRequests()
```
    Returns the set of incoming service chain requests of the node: those which have the node as a potential end node
    
    Returns:
    
    see above
  - getIncomingServiceChains
```
public SortedSet<WServiceChain> getIncomingServiceChains()
```
    Returns the set of incoming service chains to the node, including those ended in a VNF in the node
    
    Returns:
    
    see above
  - getInOutOrTraversingLigtpaths
```
public SortedSet<WLightpathUnregenerated> getInOutOrTraversingLigtpaths()
```
    Returns the set of incoming, outgoing and traversing lightpaths to the node
    
    Returns:
    
    see above
  - getInOutOrTraversingServiceChains
```
public SortedSet<WServiceChain> getInOutOrTraversingServiceChains()
```
    Returns the set of incoming, outgoing and traversing service chains to the node.
    
    Returns:
    
    see above
  - getName
```
public String getName()
```
    Returns the node name, which must be unique among all the nodes
    
    Returns:
    
    see above
  - getNe
```
public Node 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
  - getNodePositionXY
```
public Point2D getNodePositionXY()
```
    Returns the (X,Y) node position
    
    Returns:
    
    see above
  - getOccupiedCpus
```
public double getOccupiedCpus()
```
    Returns the current number of occupied CPUs by the instantiated VNFs
    
    Returns:
    
    see above
  - getOccupiedHdGB
```
public double getOccupiedHdGB()
```
    Returns the current amount of occupied hard-disk (in giga bytes) by the instantiated VNFs
    
    Returns:
    
    see above
  - getOccupiedRamGB
```
public double getOccupiedRamGB()
```
    Returns the current amount of occupied RAM (in giga bytes) by the instantiated VNFs
    
    Returns:
    
    see above
  - getOutgoingFibers
```
public SortedSet<WFiber> getOutgoingFibers()
```
    Returns the set of outgoing fibers of the node
    
    Returns:
    
    see above
  - getOutgoingIpLinks
```
public SortedSet<WIpLink> getOutgoingIpLinks()
```
    Returns the set of outgoing IP links of the node
    
    Returns:
    
    see above
  - getOutgoingLigtpathRequests
```
public SortedSet<WLightpathRequest> getOutgoingLigtpathRequests()
```
    Returns the set of outgoing lightpath requests of the node
    
    Returns:
    
    see above
  - getOutgoingLigtpaths
```
public SortedSet<WLightpathUnregenerated> getOutgoingLigtpaths()
```
    Returns the set of outgoing lightpaths of the node
    
    Returns:
    
    see above
  - getOutgoingServiceChainRequests
```
public SortedSet<WServiceChainRequest> getOutgoingServiceChainRequests()
```
    Returns the set of outgoing service chain requests of the node: those which have the node as a potential injection node
    
    Returns:
    
    see above
  - getOutgoingServiceChains
```
public SortedSet<WServiceChain> getOutgoingServiceChains()
```
    Returns the set of outgoing service chains of the node, including those starting in a VNF in the node
    
    Returns:
    
    see above
  - getPopulation
```
public double getPopulation()
```
    Returns the user-defined node population
    
    Returns:
    
    see above
  - getTotalHdGB
```
public double getTotalHdGB()
```
    Returns the total hard disk size (in GBytes) available in the node for instantiation of VNFs
    
    Returns:
    
    see above
  - getTotalNumCpus
```
public double getTotalNumCpus()
```
    Returns the number of CPUs available in the node for instantiation of VNFs
    
    Returns:
    
    see above
  - getTotalRamGB
```
public double getTotalRamGB()
```
    Returns the total RAM (in GBytes) available in the node for instantiation of VNFs
    
    Returns:
    
    see above
  - getType
```
public String getType()
```
    Returns the user-defined node type
    
    Returns:
    
    see above
  - getVnfInstances
```
public SortedSet<WVnfInstance> getVnfInstances(String type)
```
    Returns all the VNF instances in this node, of the given type
    
    Parameters:
    
    type - see above
    
    Returns:
    
    see above
  - isConnectedToNetworkCore
```
public boolean isConnectedToNetworkCore()
```
    Returns if this node is connected to a core node (core nodes are not in the design)
    
    Returns:
    
    see above
  - isUp
```
public boolean isUp()
```
    Indicates if the node is up or down (failed)
    
    Returns:
    
    see above
  - remove
```
public void remove()
```
    Removes this node, and all the ending and initiated links, or traversing lightpaths or service chains
  - setArbitraryParamString
```
public void setArbitraryParamString(String s)
```
  - setAsDown
```
public void setAsDown()
```
    Sets the node as down (failed), so traversing IP links or lightpaths become down
  - setAsUp
```
public void setAsUp()
```
    Sets the node as up (working, non-failed)
  - setIsConnectedToNetworkCore
```
public void setIsConnectedToNetworkCore(boolean isConnectedToCore)
```
    Sets if this node is assumed to be connected to a core node (core nodes are not in the design)
    
    Parameters:
    
    isConnectedToCore - see above
  - setName
```
public void setName(String name)
```
    Sets the node name, which must be unique among all the nodes
    
    Parameters:
    
    name - see above
  - setNodePositionXY
```
public void setNodePositionXY(Point2D position)
```
    Sets the (X,Y) node position
    
    Parameters:
    
    position - see above
  - setPoputlation
```
public void setPoputlation(double population)
```
    Sets the user-defined node population
    
    Parameters:
    
    population - see above
  - setTotalHdGB
```
public void setTotalHdGB(double totalHdGB)
```
    Sets the total hard disk size (in GBytes) available in the node for instantiation of VNFs
    
    Parameters:
    
    totalHdGB - see above
  - setTotalNumCpus
```
public void setTotalNumCpus(double totalNumCpus)
```
    Sets the number of CPUs available in the node for instantiation of VNFs
    
    Parameters:
    
    totalNumCpus - see above
  - setTotalRamGB
```
public void setTotalRamGB(double totalRamGB)
```
    Sets the total RAM (in GBytes) available in the node for instantiation of VNFs
    
    Parameters:
    
    totalRamGB - see above
  - setType
```
public void setType(String type)
```
    Sets the user-defined node type
    
    Parameters:
    
    type - see above
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WNode

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getAllVnfInstances

getArbitraryParamString

getIncomingFibers

getIncomingIpLinks

getIncomingLigtpathRequests

getIncomingLigtpaths

getIncomingServiceChainRequests

getIncomingServiceChains

getInOutOrTraversingLigtpaths

getInOutOrTraversingServiceChains

getName

getNe

getNodePositionXY

getOccupiedCpus

getOccupiedHdGB

getOccupiedRamGB

getOutgoingFibers

getOutgoingIpLinks

getOutgoingLigtpathRequests

getOutgoingLigtpaths

getOutgoingServiceChainRequests

getOutgoingServiceChains

getPopulation

getTotalHdGB

getTotalNumCpus

getTotalRamGB

getType

getVnfInstances

isConnectedToNetworkCore

isUp

remove

setArbitraryParamString

setAsDown

setAsUp

setIsConnectedToNetworkCore

setName

setNodePositionXY

setPoputlation

setTotalHdGB

setTotalNumCpus

setTotalRamGB

setType

toString