Node (net2plan-javadoc 0.6.0.1 API)

java.lang.Object
- com.net2plan.interfaces.networkDesign.NetworkElement
- - com.net2plan.interfaces.networkDesign.Node

All Implemented Interfaces:

Comparable<NetworkElement>
```
public class Node
extends NetworkElement
```
This class contains a representation of a node.
- A node has a name and a (X,Y) position in a map. It can be up or down (failed).
- In multilayer networks, nodes can have links at different layers.
- A node can belong to one or more shared risk groups (SRG).
- A node can be up or down. The behavior respect to the routing in the input and output nodes links, of having a node down, is equivalent to making all the node input and output links as down.
Since:

0.4.0

Author:

Pablo Pavon-Marino

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToPlanningDomain(String planningDomain)` Remove this node from the given planning domain, if it belongs to it
`SortedSet<MulticastTree>`	`getAssociatedMulticastTrees(NetworkLayer... optionalLayerParameter)` Returns the set of multicast trees that start, end or traverse this node, in the given layer.
`SortedSet<Route>`	`getAssociatedRoutes(NetworkLayer... optionalLayerParameter)` Returns the set of routes that start, end or traverse this node, in the given layer.
`double`	`getEgressCarriedMulticastTraffic(NetworkLayer... optionalLayerParameter)` Returns the total current multicast carried traffic ending in the node, counting the multicast demands at the given layer.
`double`	`getEgressCarriedTraffic(NetworkLayer... optionalLayerParameter)` Returns the total current carried traffic ending in the node, counting the demands at the given layer.
`double`	`getEgressOfferedMulticastTraffic(NetworkLayer... optionalLayerParameter)` Returns the total multicast offered traffic ending in the node, counting the multicast demands at the given layer.
`double`	`getEgressOfferedTraffic(NetworkLayer... optionalLayerParameter)` Returns the total unicast offered traffic ending in the node, counting the demands at the given layer.
`SortedSet<Route>`	`getExpressRoutes(NetworkLayer... optionalLayerParameter)` Returns the set of routes that traverse this node but not as the origin node of the first link, nor the ending node of the last link
`SortedMap<Pair<Demand,Link>,Double>`	`getForwardingRules(Demand demand)` Returns the set of forwarding rules of links initiated in the node and associated to the given demand (the links are then in the same layer as the demand), that have a non-zero splitting factor
`SortedMap<Pair<Demand,Link>,Double>`	`getForwardingRules(NetworkLayer... optionalLayerParameter)` Returns the set of forwarding rules of links initiated in the node of the given layer, which have a non-zero splitting factor.
`SortedSet<Demand>`	`getIncomingDemands(NetworkLayer... optionalLayerParameter)` Returns the set of demands ending in the node, in the given layer.
`SortedSet<Demand>`	`getIncomingDemandsAllLayers()` Returns the set of demands ending in the node, in any layer.
`SortedSet<Link>`	`getIncomingLinks(NetworkLayer... optionalLayerParameter)` Returns the set of links ending in the node, in the given layer.
`SortedSet<Link>`	`getIncomingLinksAllLayers()` Returns the set of links ending in the node at any layer.
`double`	`getIncomingLinksCapacity(NetworkLayer... optionalLayerParameter)` Returns the total capacity in the links of te given layer entering the node.
`double`	`getIncomingLinksTraffic(NetworkLayer... optionalLayerParameter)` Returns the total carried in the links of te given layer entering the node.
`SortedSet<MulticastDemand>`	`getIncomingMulticastDemands(NetworkLayer... optionalLayerParameter)` Returns the set of multicast demands ending in the node, in the given layer.
`SortedSet<MulticastDemand>`	`getIncomingMulticastDemandsAllLayers()` Returns the set of multicast demands ending in the node, in any layer.
`SortedSet<MulticastTree>`	`getIncomingMulticastTrees(NetworkLayer... optionalLayerParameter)` Returns the set of multicast trees ending in the node, in the given layer.
`SortedSet<Route>`	`getIncomingRoutes(NetworkLayer... optionalLayerParameter)` Returns the set of routes ending in the node, in the given layer.
`double`	`getIngressCarriedMulticastTraffic(NetworkLayer... optionalLayerParameter)` Returns the total current multicast carried traffic initiated in the node, counting the multicast demands at the given layer.
`double`	`getIngressCarriedTraffic(NetworkLayer... optionalLayerParameter)` Returns the total current carried traffic initiated in the node, counting the demands at the given layer.
`double`	`getIngressOfferedMulticastTraffic(NetworkLayer... optionalLayerParameter)` Returns the total multicast offered traffic initiated in the node, counting the multicast demands at the given layer.
`double`	`getIngressOfferedTraffic(NetworkLayer... optionalLayerParameter)` Returns the total unicast offered traffic initited in the node, counting the demands at the given layer.
`SortedSet<Node>`	`getInNeighbors(NetworkLayer... optionalLayerParameter)` Returns the nodes directly connected to this, with links ending in this node at the given layer.
`SortedSet<Node>`	`getInNeighborsAllLayers()` Returns the nodes directly connected to this, with links ending in this node at any layer.
`double`	`getNodeIconRelativeSize(NetworkLayer layer)` Returns the relative size (a number greater than zero), of the icon of this node in the GUI.
`SortedSet<Demand>`	`getOutgoingDemands(NetworkLayer... optionalLayerParameter)` Returns the set of demands initiated in the node, in the given layer.
`SortedSet<Demand>`	`getOutgoingDemandsAllLayers()` Returns the set of demands initiated in the node, in any layer.
`SortedSet<Link>`	`getOutgoingLinks(NetworkLayer... optionalLayerParameter)` Returns the set of links initiated in the node, in the given layer.
`SortedSet<Link>`	`getOutgoingLinksAllLayers()` Returns the set of links initiated in the node in all layer.
`double`	`getOutgoingLinksCapacity(NetworkLayer... optionalLayerParameter)` Returns the total capacity in the links of te given layer entering the node.
`double`	`getOutgoingLinksTraffic(NetworkLayer... optionalLayerParameter)` Returns the total carried in the links of te given layer entering the node.
`SortedSet<MulticastDemand>`	`getOutgoingMulticastDemands(NetworkLayer... optionalLayerParameter)` Returns the set of multicast demands initiated in the node, in the given layer.
`SortedSet<MulticastDemand>`	`getOutgoingMulticastDemandsAllLayers()` Returns the set of multicast demands initiated in the node, in any layer.
`SortedSet<MulticastTree>`	`getOutgoingMulticastTrees(NetworkLayer... optionalLayerParameter)` Returns the set of multicast tree initiated in the node, in the given layer.
`SortedSet<Route>`	`getOutgoingRoutes(NetworkLayer... optionalLayerParameter)` Returns the set of routes initiated in the node, in the given layer.
`SortedSet<Node>`	`getOutNeighbors(NetworkLayer... optionalLayerParameter)` Returns the nodes directly connected to this, with links initiated in this node at the given layer.
`SortedSet<Node>`	`getOutNeighborsAllLayers()` Returns the nodes directly connected to this, with links initiated in this node at any layer.
`SortedSet<String>`	`getPlanningDomains()` Returns the set of planning domains this node belongs to (could be empty)
`double`	`getPopulation()` Returns the node population
`SortedSet<Resource>`	`getResources(String... type)` Returns the set of resources that this node hosts.
`String`	`getSiteName()` Returns the name of the site this node is associated to (or null if none)
`SortedSet<SharedRiskGroup>`	`getSRGs()` Returns the set of shared risk groups (SRGs) this node belongs to.
`URL`	`getUrlNodeIcon(NetworkLayer layer)` Returns the url of the icon specified by the user to represent this node at the given layer, or null if none
`SortedSet<NetworkLayer>`	`getWorkingLayers()` Returns the layers where this node is working: has at least one link, or demand, or multicast demand at the given layer associated to it.
`Point2D`	`getXYPositionMap(String... layout)` Returns node position in the map, in the given layout (or the currently active if none)
`boolean`	`isDown()` Returns true if the node is down (failure state)
`boolean`	`isIsolated()` Returns true if the node is fully isolated at all layers, with no links nor demands affecting it
`boolean`	`isUp()` Returns true if the node is up (no failure state)
`boolean`	`isWorkingAtLayer(NetworkLayer layer)` Returns true has at least one link, or demand, or multicast demand at the given layer associated to it.
`void`	`remove()` Removes a node, and any associated link, demand, route or forwarding rule.
`void`	`removeAllForwardingRules(NetworkLayer... optionalLayerParameter)` Removes all forwarding rules associated to the node for a given layer (that is, of layer links outgoing from the node).
`void`	`removeFromPlanningDomain(String planningDomain)` Remove this node from the given planning domain, if it belongs to it
`void`	`removeUrlNodeIcon(NetworkLayer layer)` Removes any previous url of the node icon for this layer (if any)
`boolean`	`setFailureState(boolean setAsUp)` SortedSet the failure state of the node: up or down.
`void`	`setPopulation(double population)` Sets the population of the node (must be non-negative)
`void`	`setSiteName(String site)` Sets the name of the site this node is associated to, removing previous site name information.
`void`	`setUrlNodeIcon(NetworkLayer layer, URL url, Double relativeSize)` Sets the url of the icon specified by the user to represent this node at the given layer, and the relative size respect to other nodes.
`void`	`setXYPositionMap(Point2D pos, String... layout)` Sets the node position in the map, in the current layout, used for visualization
`String`	`toString()` Returns a `String` representation of the node.

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - addToPlanningDomain
```
public void addToPlanningDomain(String planningDomain)
```
    Remove this node from the given planning domain, if it belongs to it
    
    Parameters:
    
    planningDomain - Planning domain name
  - getAssociatedMulticastTrees
```
public SortedSet<MulticastTree> getAssociatedMulticastTrees(NetworkLayer... optionalLayerParameter)
```
    Returns the set of multicast trees that start, end or traverse this node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional
    
    Returns:
    
    The trees, or an empty set if none
  - getAssociatedRoutes
```
public SortedSet<Route> getAssociatedRoutes(NetworkLayer... optionalLayerParameter)
```
    Returns the set of routes that start, end or traverse this node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The routes, or an empty set if none
  - getEgressCarriedMulticastTraffic
```
public double getEgressCarriedMulticastTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the total current multicast carried traffic ending in the node, counting the multicast demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The carried traffic ending in the node
  - getEgressCarriedTraffic
```
public double getEgressCarriedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the total current carried traffic ending in the node, counting the demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The carried traffic ending in the node
  - getEgressOfferedMulticastTraffic
```
public double getEgressOfferedMulticastTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the total multicast offered traffic ending in the node, counting the multicast demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The total multicast offered traffic ending in the node
  - getEgressOfferedTraffic
```
public double getEgressOfferedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the total unicast offered traffic ending in the node, counting the demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The total unicast egress traffic ending in the node
  - getExpressRoutes
```
public SortedSet<Route> getExpressRoutes(NetworkLayer... optionalLayerParameter)
```
    Returns the set of routes that traverse this node but not as the origin node of the first link, nor the ending node of the last link
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The routes, or an empty set if none
  - getForwardingRules
```
public SortedMap<Pair<Demand,Link>,Double> getForwardingRules(Demand demand)
```
    Returns the set of forwarding rules of links initiated in the node and associated to the given demand (the links are then in the same layer as the demand), that have a non-zero splitting factor
    
    Parameters:
    
    demand - The demand
    
    Returns:
    
    The map associating the demand-link pair, with the associated splitting factor
  - getForwardingRules
```
public SortedMap<Pair<Demand,Link>,Double> getForwardingRules(NetworkLayer... optionalLayerParameter)
```
    Returns the set of forwarding rules of links initiated in the node of the given layer, which have a non-zero splitting factor. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The map associating the demand-link pair, with the associated splitting factor
  - getIncomingDemands
```
public SortedSet<Demand> getIncomingDemands(NetworkLayer... optionalLayerParameter)
```
    Returns the set of demands ending in the node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    the demands, or an empty set if none
  - getIncomingDemandsAllLayers
```
public SortedSet<Demand> getIncomingDemandsAllLayers()
```
    Returns the set of demands ending in the node, in any layer.
    
    Returns:
    
    The set of demands, or an empty set if none (as an unmodifiable set)
  - getIncomingLinks
```
public SortedSet<Link> getIncomingLinks(NetworkLayer... optionalLayerParameter)
```
    Returns the set of links ending in the node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - the layer
    
    Returns:
    
    the of incoming links, or an empty set if none
  - getIncomingLinksAllLayers
```
public SortedSet<Link> getIncomingLinksAllLayers()
```
    Returns the set of links ending in the node at any layer.
    
    Returns:
    
    The set of incoming links, or an empty set if none (as an unmodifiable set)
  - getIncomingLinksCapacity
```
public double getIncomingLinksCapacity(NetworkLayer... optionalLayerParameter)
```
    Returns the total capacity in the links of te given layer entering the node. If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    see above
  - getIncomingLinksTraffic
```
public double getIncomingLinksTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the total carried in the links of te given layer entering the node. If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    see above
  - getIncomingMulticastDemands
```
public SortedSet<MulticastDemand> getIncomingMulticastDemands(NetworkLayer... optionalLayerParameter)
```
    Returns the set of multicast demands ending in the node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The demands, or an empty set if none
  - getIncomingMulticastDemandsAllLayers
```
public SortedSet<MulticastDemand> getIncomingMulticastDemandsAllLayers()
```
    Returns the set of multicast demands ending in the node, in any layer.
    
    Returns:
    
    The set of demands, or an empty set if none (as an unmodifiable set)
  - getIncomingMulticastTrees
```
public SortedSet<MulticastTree> getIncomingMulticastTrees(NetworkLayer... optionalLayerParameter)
```
    Returns the set of multicast trees ending in the node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The multicast trees, or an empty set if none
  - getIncomingRoutes
```
public SortedSet<Route> getIncomingRoutes(NetworkLayer... optionalLayerParameter)
```
    Returns the set of routes ending in the node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer
    
    Returns:
    
    The routes, or an empty set if none
  - getIngressCarriedMulticastTraffic
```
public double getIngressCarriedMulticastTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the total current multicast carried traffic initiated in the node, counting the multicast demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The total multicast carried traffic initiated in the node
  - getIngressCarriedTraffic
```
public double getIngressCarriedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the total current carried traffic initiated in the node, counting the demands at the given layer. If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The total carried traffic initiated in the node
  - getIngressOfferedMulticastTraffic
```
public double getIngressOfferedMulticastTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the total multicast offered traffic initiated in the node, counting the multicast demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The total multicast offered traffic initiated in the node
  - getIngressOfferedTraffic
```
public double getIngressOfferedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the total unicast offered traffic initited in the node, counting the demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The total offered traffic initiated in the node
  - getInNeighbors
```
public SortedSet<Node> getInNeighbors(NetworkLayer... optionalLayerParameter)
```
    Returns the nodes directly connected to this, with links ending in this node at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The set of neighbor nodes
  - getInNeighborsAllLayers
```
public SortedSet<Node> getInNeighborsAllLayers()
```
    Returns the nodes directly connected to this, with links ending in this node at any layer.
    
    Returns:
    
    The set of neighbor nodes
  - getNodeIconRelativeSize
```
public double getNodeIconRelativeSize(NetworkLayer layer)
```
    Returns the relative size (a number greater than zero), of the icon of this node in the GUI.
    
    Parameters:
    
    layer - the layer
    
    Returns:
    
    see above
  - getOutgoingDemands
```
public SortedSet<Demand> getOutgoingDemands(NetworkLayer... optionalLayerParameter)
```
    Returns the set of demands initiated in the node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The demands, or an empty set if none
  - getOutgoingDemandsAllLayers
```
public SortedSet<Demand> getOutgoingDemandsAllLayers()
```
    Returns the set of demands initiated in the node, in any layer.
    
    Returns:
    
    the set of demands, or an empty set if none (as an unmodifiable set)
  - getOutgoingLinks
```
public SortedSet<Link> getOutgoingLinks(NetworkLayer... optionalLayerParameter)
```
    Returns the set of links initiated in the node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The set of outgoing links, or an empty set if none
  - getOutgoingLinksAllLayers
```
public SortedSet<Link> getOutgoingLinksAllLayers()
```
    Returns the set of links initiated in the node in all layer.
    
    Returns:
    
    The set of outgoing links, or an empty set if none (as an unmodifiable set)
  - getOutgoingLinksCapacity
```
public double getOutgoingLinksCapacity(NetworkLayer... optionalLayerParameter)
```
    Returns the total capacity in the links of te given layer entering the node. If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    see above
  - getOutgoingLinksTraffic
```
public double getOutgoingLinksTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the total carried in the links of te given layer entering the node. If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    see above
  - getOutgoingMulticastDemands
```
public SortedSet<MulticastDemand> getOutgoingMulticastDemands(NetworkLayer... optionalLayerParameter)
```
    Returns the set of multicast demands initiated in the node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The demands, or an empty set if none
  - getOutgoingMulticastDemandsAllLayers
```
public SortedSet<MulticastDemand> getOutgoingMulticastDemandsAllLayers()
```
    Returns the set of multicast demands initiated in the node, in any layer.
    
    Returns:
    
    The set of demands, or an empty set if none (as an unmodifiable set)
  - getOutgoingMulticastTrees
```
public SortedSet<MulticastTree> getOutgoingMulticastTrees(NetworkLayer... optionalLayerParameter)
```
    Returns the set of multicast tree initiated in the node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - The layer
    
    Returns:
    
    The multicast trees, or an empty set if none
  - getOutgoingRoutes
```
public SortedSet<Route> getOutgoingRoutes(NetworkLayer... optionalLayerParameter)
```
    Returns the set of routes initiated in the node, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The set of routes, or an empty set if none
  - getOutNeighbors
```
public SortedSet<Node> getOutNeighbors(NetworkLayer... optionalLayerParameter)
```
    Returns the nodes directly connected to this, with links initiated in this node at the given layer. If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer
    
    Returns:
    
    The set of neighbor nodes
  - getOutNeighborsAllLayers
```
public SortedSet<Node> getOutNeighborsAllLayers()
```
    Returns the nodes directly connected to this, with links initiated in this node at any layer.
    
    Returns:
    
    The set of neighbor nodes
  - getPlanningDomains
```
public SortedSet<String> getPlanningDomains()
```
    Returns the set of planning domains this node belongs to (could be empty)
    
    Returns:
    
    see above
  - getPopulation
```
public double getPopulation()
```
    Returns the node population
    
    Returns:
    
    see above
  - getResources
```
public SortedSet<Resource> getResources(String... type)
```
    Returns the set of resources that this node hosts. If no resource is provided, all the resources of all types are provided. If one ore more optional parameters type are given, a set with the hosted resources of any of those types is returned (or an empty set if none)
    
    Parameters:
    
    type - one or more optional types (optional)
    
    Returns:
    
    the set
  - getSiteName
```
public String getSiteName()
```
    Returns the name of the site this node is associated to (or null if none)
    
    Returns:
    
    see above
  - getSRGs
```
public SortedSet<SharedRiskGroup> getSRGs()
```
    Returns the set of shared risk groups (SRGs) this node belongs to.
    
    Returns:
    
    The set of SRGs as an unmodifiable set
  - getUrlNodeIcon
```
public URL getUrlNodeIcon(NetworkLayer layer)
```
    Returns the url of the icon specified by the user to represent this node at the given layer, or null if none
    
    Parameters:
    
    layer - the layer
    
    Returns:
    
    the url
  - getWorkingLayers
```
public SortedSet<NetworkLayer> getWorkingLayers()
```
    Returns the layers where this node is working: has at least one link, or demand, or multicast demand at the given layer associated to it.
    
    Returns:
    
    see above
  - getXYPositionMap
```
public Point2D getXYPositionMap(String... layout)
```
    Returns node position in the map, in the given layout (or the currently active if none)
    
    Parameters:
    
    layout - see above
    
    Returns:
    
    The position in the map used for visualization
  - isDown
```
public boolean isDown()
```
    Returns true if the node is down (failure state)
    
    Returns:
    
    See description above
  - isIsolated
```
public boolean isIsolated()
```
    Returns true if the node is fully isolated at all layers, with no links nor demands affecting it
    
    Returns:
    
    see above
  - isUp
```
public boolean isUp()
```
    Returns true if the node is up (no failure state)
    
    Returns:
    
    See description above
  - isWorkingAtLayer
```
public boolean isWorkingAtLayer(NetworkLayer layer)
```
    Returns true has at least one link, or demand, or multicast demand at the given layer associated to it.
    
    Parameters:
    
    layer - Network layer
    
    Returns:
    
    see above
  - remove
```
public void remove()
```
    Removes a node, and any associated link, demand, route or forwarding rule.
  - removeAllForwardingRules
```
public void removeAllForwardingRules(NetworkLayer... optionalLayerParameter)
```
    Removes all forwarding rules associated to the node for a given layer (that is, of layer links outgoing from the node). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - the layer
  - removeFromPlanningDomain
```
public void removeFromPlanningDomain(String planningDomain)
```
    Remove this node from the given planning domain, if it belongs to it
    
    Parameters:
    
    planningDomain - Planning domain name
  - removeUrlNodeIcon
```
public void removeUrlNodeIcon(NetworkLayer layer)
```
    Removes any previous url of the node icon for this layer (if any)
    
    Parameters:
    
    layer - the layer
  - setFailureState
```
public boolean setFailureState(boolean setAsUp)
```
    SortedSet the failure state of the node: up or down. Returns the previous failure state. The routing is automatically updated, making the traffic of the traversing routes as zero, and the hop-by-hop routing is updated as if the forwarding rules of input and output links were zero
    
    Parameters:
    
    setAsUp - The new failure state (true up, false down)
    
    Returns:
    
    The previous failure state
  - setPopulation
```
public void setPopulation(double population)
```
    Sets the population of the node (must be non-negative)
    
    Parameters:
    
    population - the population
  - setSiteName
```
public void setSiteName(String site)
```
    Sets the name of the site this node is associated to, removing previous site name information. If site is null, the current site name es removed, and the node becomes not attached to any site name.
    
    Parameters:
    
    site - te site name
  - setUrlNodeIcon
```
public void setUrlNodeIcon(NetworkLayer layer,
                           URL url,
                           Double relativeSize)
```
    Sets the url of the icon specified by the user to represent this node at the given layer, and the relative size respect to other nodes. Previous url and relative size for this layer (if any) will be removed
    
    Parameters:
    
    layer - the layer
    
    url - the url
    
    relativeSize - the relative size (strictly positive number)
  - setXYPositionMap
```
public void setXYPositionMap(Point2D pos,
                             String... layout)
```
    Sets the node position in the map, in the current layout, used for visualization
    
    Parameters:
    
    pos - New node position
    
    layout - optionally, we can provide the layout where to set the position
  - toString
```
public String toString()
```
    Returns a String representation of the node.
    
    Overrides:
    
    toString in class NetworkElement
    
    Returns:
    
    String representation of the node

Class Node

Method Summary

Methods inherited from class com.net2plan.interfaces.networkDesign.NetworkElement

Methods inherited from class java.lang.Object

Method Detail

addToPlanningDomain

getAssociatedMulticastTrees

getAssociatedRoutes

getEgressCarriedMulticastTraffic

getEgressCarriedTraffic

getEgressOfferedMulticastTraffic

getEgressOfferedTraffic

getExpressRoutes

getForwardingRules

getForwardingRules

getIncomingDemands

getIncomingDemandsAllLayers

getIncomingLinks

getIncomingLinksAllLayers

getIncomingLinksCapacity

getIncomingLinksTraffic

getIncomingMulticastDemands

getIncomingMulticastDemandsAllLayers

getIncomingMulticastTrees

getIncomingRoutes

getIngressCarriedMulticastTraffic

getIngressCarriedTraffic

getIngressOfferedMulticastTraffic

getIngressOfferedTraffic

getInNeighbors

getInNeighborsAllLayers

getNodeIconRelativeSize

getOutgoingDemands

getOutgoingDemandsAllLayers

getOutgoingLinks

getOutgoingLinksAllLayers

getOutgoingLinksCapacity

getOutgoingLinksTraffic

getOutgoingMulticastDemands

getOutgoingMulticastDemandsAllLayers

getOutgoingMulticastTrees

getOutgoingRoutes

getOutNeighbors

getOutNeighborsAllLayers

getPlanningDomains

getPopulation

getResources

getSiteName

getSRGs

getUrlNodeIcon

getWorkingLayers

getXYPositionMap

isDown

isIsolated

isUp

isWorkingAtLayer

remove

removeAllForwardingRules

removeFromPlanningDomain

removeUrlNodeIcon

setFailureState

setPopulation

setSiteName

setUrlNodeIcon

setXYPositionMap

toString