Resource (net2plan-javadoc 0.6.0.1 API)

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

All Implemented Interfaces:

Comparable<NetworkElement>
```
public class Resource
extends NetworkElement
```
.

Author:

Pablo Pavon-Marino

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attachToNode(Node node)` Attaches this resource, now dettached of other node, to a new indicated node.
`void`	`dettachFromNode()` Dettaches this resource from its current node, so it will stop using any base resources.
`SortedSet<Resource>`	`getBaseResources()` Returns the set of base resources of this resource
`double`	`getCapacity()` Gets the capacity in resource units of this resource
`String`	`getCapacityMeasurementUnits()` Gets the units in which the capacity of this resource is measured
`double`	`getCapacityOccupiedByUpperResource(Resource upperResource)` Returns the capacity that upperResource occupied in this resource.
`SortedMap<Resource,Double>`	`getCapacityOccupiedByUpperResourcesMap()` Returns the map with the information on the upper resources (the resources for which this resource is a base resource), and the amount of occupied capacity they are incurring in me
`double`	`getCapacityOccupiedInBaseResource(Resource baseResource)` Returns the capacity that this resource is occupying in the base resource.
`SortedMap<Resource,Double>`	`getCapacityOccupiedInBaseResourcesMap()` Returns the map with an element for each base resource, and the key the amount of capacity occupied in it
`Optional<Node>`	`getHostNode()` Returns the host node of this resource
`double`	`getOccupiedCapacity()` Gets the occupied capacity in resource units of this resource
`double`	`getProcessingTimeToTraversingTrafficInMs()` Gets the processing time added to every traversing traffic
`SortedSet<Demand>`	`getTraversingDemands()` Returns a set with the demands that have at least one route traversing this resource
`double`	`getTraversingRouteOccupiedCapacity(Route route)` Returns the capacity that is occupied in this resource, because of a traversing route.
`SortedMap<Route,Double>`	`getTraversingRouteOccupiedCapacityMap()` Returns a map with one key per each traversing route, and associated to it the amount of capacity occupied in this resource because of it.
`SortedSet<Route>`	`getTraversingRoutes()` Returns a set with the routes that are traversing this resource
`String`	`getType()` Returns the String describing the type of the node
`SortedSet<Resource>`	`getUpperResources()` Returns the set of resources that are above of this resource, so this resource is a base resource for them
`URL`	`getUrlIcon()` Returns the url of the icon specified by the user to represent this resource, or null if none
`double`	`getUtilization()` Returns resource link utilization, measured as the ratio between the total occupied capacity in the total capacity.
`boolean`	`iAttachedToANode()` Indicates if this resource is attached to a node, or else, is not attached to any
`boolean`	`isHavingMoreThanOneBaseResourceWithTheSameType()` Indicates if the resource has more than one bsae resource with the same type
`boolean`	`isOversubscribed()` Returns true if the occupied capacity of the resource exceeds its capacity
`void`	`remove()` Removes this Resource.
`void`	`setCapacity(double newCapacity, Map<Resource,Double> newCapacityIOccupyInBaseResourcesMap)` Resets the capacity of a resource, as well as the occupied capacity in the base resources.
`void`	`setCapacityMeasurementUnits(String units)` Sets the units in which the capacity of this resource is measured
`void`	`setProcessingTimeToTraversingTrafficInMs(double time)` Sets the processing time added to every traversing traffic
`void`	`setUrlIcon(URL url)` Sets the url of the icon specified by the user to represent this resource.
`String`	`toString()` Returns a `String` representation of the Shared Risk Group.

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

- Method Detail
  - attachToNode
```
public void attachToNode(Node node)
```
    Attaches this resource, now dettached of other node, to a new indicated node. The user can later use setCapacity method to add base resources and its occupation
    
    Parameters:
    
    node - see above
  - dettachFromNode
```
public void dettachFromNode()
```
    Dettaches this resource from its current node, so it will stop using any base resources. Only possible if the resource is not being traversed by any service chain, or used by any upper resource.
  - getBaseResources
```
public SortedSet<Resource> getBaseResources()
```
    Returns the set of base resources of this resource
    
    Returns:
    
    the set of base resources (an unmodificable set)
  - getCapacity
```
public double getCapacity()
```
    Gets the capacity in resource units of this resource
    
    Returns:
    
    the capacity
  - getCapacityMeasurementUnits
```
public String getCapacityMeasurementUnits()
```
    Gets the units in which the capacity of this resource is measured
    
    Returns:
    
    the capacityMeasurementUnits
  - getCapacityOccupiedByUpperResource
```
public double getCapacityOccupiedByUpperResource(Resource upperResource)
```
    Returns the capacity that upperResource occupied in this resource. If thi resource is not a base for upperResource, 0 is returned
    
    Parameters:
    
    upperResource - the resource for which this resource is a base resource
    
    Returns:
    
    the occupied capacity in this resource by the given upper resource
  - getCapacityOccupiedByUpperResourcesMap
```
public SortedMap<Resource,Double> getCapacityOccupiedByUpperResourcesMap()
```
    Returns the map with the information on the upper resources (the resources for which this resource is a base resource), and the amount of occupied capacity they are incurring in me
    
    Returns:
    
    the map
  - getCapacityOccupiedInBaseResource
```
public double getCapacityOccupiedInBaseResource(Resource baseResource)
```
    Returns the capacity that this resource is occupying in the base resource. If bsaeResource is not a base resource for this resource, the method returns zero
    
    Parameters:
    
    baseResource - The base resource
    
    Returns:
    
    the occupied capacity
  - getCapacityOccupiedInBaseResourcesMap
```
public SortedMap<Resource,Double> getCapacityOccupiedInBaseResourcesMap()
```
    Returns the map with an element for each base resource, and the key the amount of capacity occupied in it
    
    Returns:
    
    the map
  - getHostNode
```
public Optional<Node> getHostNode()
```
    Returns the host node of this resource
    
    Returns:
    
    the hostNode
  - getOccupiedCapacity
```
public double getOccupiedCapacity()
```
    Gets the occupied capacity in resource units of this resource
    
    Returns:
    
    the capacity
  - getProcessingTimeToTraversingTrafficInMs
```
public double getProcessingTimeToTraversingTrafficInMs()
```
    Gets the processing time added to every traversing traffic
    
    Returns:
    
    the time
  - getTraversingDemands
```
public SortedSet<Demand> getTraversingDemands()
```
    Returns a set with the demands that have at least one route traversing this resource
    
    Returns:
    
    the traversing demands
  - getTraversingRouteOccupiedCapacity
```
public double getTraversingRouteOccupiedCapacity(Route route)
```
    Returns the capacity that is occupied in this resource, because of a traversing route. If the route is not traversing the resource, zero is returned. If the route is down, the occupied capacity is zero
    
    Parameters:
    
    route - the route
    
    Returns:
    
    the occupied capacity
  - getTraversingRouteOccupiedCapacityMap
```
public SortedMap<Route,Double> getTraversingRouteOccupiedCapacityMap()
```
    Returns a map with one key per each traversing route, and associated to it the amount of capacity occupied in this resource because of it. Recall that if a route is down, its occupied capacity in the traversed resources drops to zero, and come backs to its previous value when the route becomes up again
    
    Returns:
    
    the map
  - getTraversingRoutes
```
public SortedSet<Route> getTraversingRoutes()
```
    Returns a set with the routes that are traversing this resource
    
    Returns:
    
    the traversingRoutes
  - getType
```
public String getType()
```
    Returns the String describing the type of the node
    
    Returns:
    
    the type
  - getUpperResources
```
public SortedSet<Resource> getUpperResources()
```
    Returns the set of resources that are above of this resource, so this resource is a base resource for them
    
    Returns:
    
    the set of upper resources (an unmodificable set)
  - getUrlIcon
```
public URL getUrlIcon()
```
    Returns the url of the icon specified by the user to represent this resource, or null if none
    
    Returns:
    
    the url
  - getUtilization
```
public double getUtilization()
```
    Returns resource link utilization, measured as the ratio between the total occupied capacity in the total capacity.
    
    Returns:
    
    The utilization as described above. If the resource has zero capacity and strictly positive occupied capacity, Double.POSITIVE_INFINITY is returned
  - iAttachedToANode
```
public boolean iAttachedToANode()
```
    Indicates if this resource is attached to a node, or else, is not attached to any
    
    Returns:
    
    see above
  - isHavingMoreThanOneBaseResourceWithTheSameType
```
public boolean isHavingMoreThanOneBaseResourceWithTheSameType()
```
    Indicates if the resource has more than one bsae resource with the same type
    
    Returns:
    
    see above
  - isOversubscribed
```
public boolean isOversubscribed()
```
    Returns true if the occupied capacity of the resource exceeds its capacity
    
    Returns:
    
    See above
  - remove
```
public void remove()
```
    Removes this Resource. Before that, it removes all the traversing routes (if any), and removes all the resources that are based on this (if any).
  - setCapacity
```
public void setCapacity(double newCapacity,
                        Map<Resource,Double> newCapacityIOccupyInBaseResourcesMap)
```
    Resets the capacity of a resource, as well as the occupied capacity in the base resources. If the resource is currently being used by an upper resource, the set of base resources cannot have new elements respect to the ones already established in the constructor. This limit is set to avoid loops in resources occupations. Any base resource that is in the current map, that is not in newCapacityIOccupyInBaseResourcesMap, is assumed to maintain the same occupation.
    
    Parameters:
    
    newCapacity - the new capacity value to set in this resource
    
    newCapacityIOccupyInBaseResourcesMap - a map with the update of the capacities to occupy in the base resources. If null, an empty map is assumed.
  - setCapacityMeasurementUnits
```
public void setCapacityMeasurementUnits(String units)
```
    Sets the units in which the capacity of this resource is measured
    
    Parameters:
    
    units - see above
  - setProcessingTimeToTraversingTrafficInMs
```
public void setProcessingTimeToTraversingTrafficInMs(double time)
```
    Sets the processing time added to every traversing traffic
    
    Parameters:
    
    time - the new processing time (cannot be negative)
  - setUrlIcon
```
public void setUrlIcon(URL url)
```
    Sets the url of the icon specified by the user to represent this resource. A null value removes current URL
    
    Parameters:
    
    url - the url
  - toString
```
public String toString()
```
    Returns a String representation of the Shared Risk Group.
    
    Overrides:
    
    toString in class NetworkElement
    
    Returns:
    
    String representation of the SRG

Class Resource

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

attachToNode

dettachFromNode

getBaseResources

getCapacity

getCapacityMeasurementUnits

getCapacityOccupiedByUpperResource

getCapacityOccupiedByUpperResourcesMap

getCapacityOccupiedInBaseResource

getCapacityOccupiedInBaseResourcesMap

getHostNode

getOccupiedCapacity

getProcessingTimeToTraversingTrafficInMs

getTraversingDemands

getTraversingRouteOccupiedCapacity

getTraversingRouteOccupiedCapacityMap

getTraversingRoutes

getType

getUpperResources

getUrlIcon

getUtilization

iAttachedToANode

isHavingMoreThanOneBaseResourceWithTheSameType

isOversubscribed

remove

setCapacity

setCapacityMeasurementUnits

setProcessingTimeToTraversingTrafficInMs

setUrlIcon

toString