Route (net2plan-javadoc 0.6.0.1 API)

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

All Implemented Interfaces:

Comparable<NetworkElement>
```
public class Route
extends NetworkElement
```
This class contains a representation of a unidirectional route, an structure used to carry traffic of unicast demands at a layer, when the layer routing type is source routing. Routes are characterized by the unicast demand they carry traffic of, the traversed links which should form a path from the demand ingress node to the demand egress node, the amount of traffic of the demand that they carry (in traffic units of the layer), amount of link capacity that they occupy in the traversed links (in link capacoty units for its layer).

Naturally, the links and the demand belong to the same layer, the layer of the route.

Routes can be rerouted (change in its sequence of links), and its carried traffic and occupied capacity can change, but not its associate demand. If a route traverses a link or node that is down, its carried traffic automatically drops to zero. If the failing links/nodes are set to up state, its carried traffic and occupied link capacity goes back to the value before the failure.

Routes can be associated to an arbitrary number of protection segments. Protection segments are just reserved capacity in the links, that a route may use. Typically, a built-in or user-made algorithm that reacts to link and node failures decides how and when the assigned protection segments to a route are used.

Since:

0.4.0

Author:

Pablo Pavon-Marino

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBackupRoute(Route backupRoute)` Adds an existing route backupRoute in the same demand, designating it as a backup of this route.
`Route`	`createBidirectionalOppositePair()` Creates a route in the opposite direction as this, and associate both as bidirectional pairs.
`List<Route>`	`getBackupRoutes()` Returns the list of backup routes for this route (the ones defined as backup by the user)
`Route`	`getBidirectionalPair()` If this route was added using the method addRouteBidirectional(), returns the route in the other direction (if it was not previously removed).
`double`	`getCarriedTraffic()` Returns the route carried traffic at this moment.
`double`	`getCarriedTrafficInNoFailureState()` Returns the route amount of carried traffic, if the route was not traversing any failing link or node.
`Demand`	`getDemand()` Returns the demand that the route is associated to
`Node`	`getEgressNode()` Returns the route egress node, which is the egress node if its associated demand
`Node`	`getFirstAvailableNodeAfterFailures()` Returns the first node in the route that is in up state after all failures in the route.
`Node`	`getFirstAvailableNodeBeforeFailures()` Returns the first node starting from the route ingress node that is in up state, and is immediatly before a failed resource for this route.
`Node`	`getIngressNode()` Returns the route ingress node, which is the ingress node if its associated demand
`Triple<Double,List<NetworkElement>,List<Double>>`	`getInitialState()` Returns the initial state of the route (the one when it was created): the carried traffic (in the no-failure state), its path (sequence of links and/or resources), and the occupation information (occupation in each link/resource travserse).
`NetworkLayer`	`getLayer()` Returns the route layer
`double`	`getLengthInKm()` Returns the route length in km, summing the traversed link lengths, as many times as the link is traversed.
`int`	`getNumberOfHops()` Returns the route number of traversed links.
`int`	`getNumberOfTimesIsTraversed(NetworkElement e)` Returns the number of times that a particular link or resource is traversed
`double`	`getOccupiedCapacity(NetworkElement... e)` Returns the route occupied capacity at this moment, at the particular link or resource.
`double`	`getOccupiedCapacityInNoFailureState(NetworkElement... e)` The same as getOccupiedCapacity, but if the network had no failures
`List<NetworkElement>`	`getOppositePath()` Return the opposite path of this route, from the destination to the origin traversing the bidirectional pairs of the traversed links, and the same resources.
`List<NetworkElement>`	`getPath()` Return the current path (sequence of links and resources) of the route.
`double`	`getPropagationDelayInMiliseconds()` Returns the route propagation delay in seconds, summing the traversed link propagation delays
`double`	`getPropagationSpeedInKmPerSecond()` Returns the route average propagation speed in km per second, as the ratio between the total route length and the total route delay (not including the processing time in the traversed resources)
`SortedSet<Route>`	`getRoutesIAmBackup()` Return the set of routes that this route is a designated as a backup for them
`List<Node>`	`getSeqIntermediateNodes()` Returns the route sequence of traversed nodes, removing the origin and end node
`List<Link>`	`getSeqLinks()` Returns the route current sequence of traversed links (without any resource traversed).
`static List<Link>`	`getSeqLinks(List<? extends NetworkElement> seqLinksAndResources)` Given a path, composed of a sequence of links and resources, extracts the list of links, filtering out the resources
`List<Node>`	`getSeqNodes()` Returns the route sequence of traversed nodes (when a resource is traversed, the resource node is not added again as a traversal)
`List<Double>`	`getSeqOccupiedCapacitiesIfNotFailing()` Returns a list of double, with one element per link or resource traversed, in the order in which they are traversed, meaning the occupation in such traversal.
`static List<Resource>`	`getSeqResources(List<? extends NetworkElement> seqLinksAndResources)` Given a path, composed of a sequence of links and resources, extracts the list of resources, filtering out the links
`List<Resource>`	`getSeqResourcesTraversed()` Returns the route current sequence of traversed resources, in the order they are traversed (and thus, a resource will appear as many times as it is traversed.
`SortedSet<SharedRiskGroup>`	`getSRGs()` Returns the SRGs the route is affected by (any traversed node or link is in the SRG)
`boolean`	`hasBackupRoutes()` Returns true if this route has at least one backup route defined
`boolean`	`hasLoops()` Returns true if the route has loops (traverses a node more than once), and false otherwise
`boolean`	`isBackupRoute()` Returns true if this route has been defined as a backup route for other
`boolean`	`isBidirectional()` Returns true if the route is bidirectional.
`boolean`	`isDown()` Returns true if the route is traversing a link or node that is down.
`boolean`	`isOccupyingDifferentCapacitiesInDifferentLinksInNoFailureState()`
`boolean`	`isServiceChain()` Indicates if the route is a serivce chain: traverses resources
`boolean`	`isTraversingZeroCapLinks()` Returns true if the route is traversing a link with zero capacity
`void`	`remove()` Removes this route.
`void`	`removeBackupRoute(Route backupRoute)` Removes the given backupRoute from the backupRoute list of this route
`void`	`setBidirectionalPair(Route r)` Sets the given route as the bidirectional pair of this route.
`void`	`setCarriedTraffic(double newCarriedTraffic, double newOccupiedLinkAndResourcesCapacities)` Sets the route carried traffic and the occupied capacity in the traversed links and resources (typically the same as the carried traffic), setting it to being the same in all the links and resources traversed.
`void`	`setCarriedTraffic(double newCarriedTraffic, List<Double> linkAndResourcesOccupationInformation)` Sets the route carried traffic and the occupied capacity in the traversed links and resources, so the capacity occupied can be different (but always non-negative) in each.
`void`	`setPath(double newCarriedTraffic, List<? extends NetworkElement> newPath, List<Double> newOccupationInformation)` Sets the new sequence of links and/or resources traversed by the route, carried traffic, and occupied capacity in the traversed links/resources If the new route traverses failing link or nodes, its current carried traffic and occupied link capacities will be zero.
`void`	`setSeqLinks(List<Link> seqLinks)` Sets the new sequence of links traversed by the route.
`String`	`toString()` Returns a `String` representation of the network element.

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

- Method Detail
  - addBackupRoute
```
public void addBackupRoute(Route backupRoute)
```
    Adds an existing route backupRoute in the same demand, designating it as a backup of this route. For this to happen, this route cannot have backup routes itself, or an exception is thrown.
    
    Parameters:
    
    backupRoute - the backup route
  - createBidirectionalOppositePair
```
public Route createBidirectionalOppositePair()
```
    Creates a route in the opposite direction as this, and associate both as bidirectional pairs. If this route is already bidirectional, makes nothing and returns null. The traversed links must be bidirectional, the demand cannot be a service chain. The opposite route carried traffic and occupied capacity is set to zero
    
    Returns:
    
    the newly created route
  - getBackupRoutes
```
public List<Route> getBackupRoutes()
```
    Returns the list of backup routes for this route (the ones defined as backup by the user)
    
    Returns:
    
    The initial sequence of links as an unmodifiable list
  - getBidirectionalPair
```
public Route getBidirectionalPair()
```
    If this route was added using the method addRouteBidirectional(), returns the route in the other direction (if it was not previously removed). Returns null otherwise.
    
    Returns:
    
    see above
  - getCarriedTraffic
```
public double getCarriedTraffic()
```
    Returns the route carried traffic at this moment. Recall that if the route is down (traverses a link or node that is down) its carried traffic is automatically set to zero. To retrieve the route carried traffic if all the links and nodes where up, use getCarriedTrafficInNoFailureState
    
    Returns:
    
    the current carried traffic
  - getCarriedTrafficInNoFailureState
```
public double getCarriedTrafficInNoFailureState()
```
    Returns the route amount of carried traffic, if the route was not traversing any failing link or node. Recall that if the route traverses faling link/nodes, its carried traffic is automatically set to zero.
    
    Returns:
    
    see description above
  - getDemand
```
public Demand getDemand()
```
    Returns the demand that the route is associated to
    
    Returns:
    
    the unicast demand
  - getEgressNode
```
public Node getEgressNode()
```
    Returns the route egress node, which is the egress node if its associated demand
    
    Returns:
    
    the route egress node, which is the egress node if its associated demand
  - getFirstAvailableNodeAfterFailures
```
public Node getFirstAvailableNodeAfterFailures()
```
    Returns the first node in the route that is in up state after all failures in the route. In case there is no failure, it will return the last node in the route. In case the last node in the route is failed, returns null.
    
    Returns:
    
    see description above
  - getFirstAvailableNodeBeforeFailures
```
public Node getFirstAvailableNodeBeforeFailures()
```
    Returns the first node starting from the route ingress node that is in up state, and is immediatly before a failed resource for this route. In case there is no failure, it will return the last node in the sequence. In case the first node in the path is failed, it will return null.
    
    Returns:
    
    the node
  - getIngressNode
```
public Node getIngressNode()
```
    Returns the route ingress node, which is the ingress node if its associated demand
    
    Returns:
    
    the route ingress node, which is the ingress node if its associated demand
  - getInitialState
```
public Triple<Double,List<NetworkElement>,List<Double>> getInitialState()
```
    Returns the initial state of the route (the one when it was created): the carried traffic (in the no-failure state), its path (sequence of links and/or resources), and the occupation information (occupation in each link/resource travserse). Note that some links/resources of this initial state could no longer exist
    
    Returns:
    
    The info
  - getLayer
```
public NetworkLayer getLayer()
```
    Returns the route layer
    
    Returns:
    
    the layer
  - getLengthInKm
```
public double getLengthInKm()
```
    Returns the route length in km, summing the traversed link lengths, as many times as the link is traversed.
    
    Returns:
    
    the length in km
  - getNumberOfHops
```
public int getNumberOfHops()
```
    Returns the route number of traversed links. Each link is counted as many times as it is traversed
    
    Returns:
    
    the number of hops of the route
  - getNumberOfTimesIsTraversed
```
public int getNumberOfTimesIsTraversed(NetworkElement e)
```
    Returns the number of times that a particular link or resource is traversed
    
    Parameters:
    
    e - the link or resource to check
    
    Returns:
    
    the number of times it is traversed
  - getOccupiedCapacity
```
public double getOccupiedCapacity(NetworkElement... e)
```
    Returns the route occupied capacity at this moment, at the particular link or resource. If no link or resource is provided, the occupied capacity in the first traversed link or resource is assumed. Recall that a route can have loops, and traverse a link/resource more than once, so the returned occupation is the sum of the occupations in each pass. If the route is down (traverses a link or node that is down) its occupied capacity in links and resources is automatically set to zero. To retrieve the route occupied link or resource capacity if all the links and nodes where up, use getOccupiedCapacityInNoFailureState.
    
    Parameters:
    
    e - one link or resource where to see the occupation (if not part of the route, zero is returned)
    
    Returns:
    
    the current occupied capacity
  - getOccupiedCapacityInNoFailureState
```
public double getOccupiedCapacityInNoFailureState(NetworkElement... e)
```
    The same as getOccupiedCapacity, but if the network had no failures
    
    Parameters:
    
    e - one link or resource where to see the occupation (if not part of the route, zero is returned). If no element is passed, the result is the one of the first traversed element
    
    Returns:
    
    the occupied capacity in no failure state
  - getOppositePath
```
public List<NetworkElement> getOppositePath()
```
    Return the opposite path of this route, from the destination to the origin traversing the bidirectional pairs of the traversed links, and the same resources. If any traversed link is not bidirectional, an exception is thrown
    
    Returns:
    
    The info
  - getPath
```
public List<NetworkElement> getPath()
```
    Return the current path (sequence of links and resources) of the route.
    
    Returns:
    
    The info
  - getPropagationDelayInMiliseconds
```
public double getPropagationDelayInMiliseconds()
```
    Returns the route propagation delay in seconds, summing the traversed link propagation delays
    
    Returns:
    
    see description above
  - getPropagationSpeedInKmPerSecond
```
public double getPropagationSpeedInKmPerSecond()
```
    Returns the route average propagation speed in km per second, as the ratio between the total route length and the total route delay (not including the processing time in the traversed resources)
    
    Returns:
    
    see description above
  - getRoutesIAmBackup
```
public SortedSet<Route> getRoutesIAmBackup()
```
    Return the set of routes that this route is a designated as a backup for them
    
    Returns:
    
    The initial sequence of links as an unmodifiable list
  - getSeqIntermediateNodes
```
public List<Node> getSeqIntermediateNodes()
```
    Returns the route sequence of traversed nodes, removing the origin and end node
    
    Returns:
    
    see description above
  - getSeqLinks
```
public List<Link> getSeqLinks()
```
    Returns the route current sequence of traversed links (without any resource traversed).
    
    Returns:
    
    see description above
  - getSeqLinks
```
public static List<Link> getSeqLinks(List<? extends NetworkElement> seqLinksAndResources)
```
    Given a path, composed of a sequence of links and resources, extracts the list of links, filtering out the resources
    
    Parameters:
    
    seqLinksAndResources - sequence of links and resources
    
    Returns:
    
    the list of links
  - getSeqNodes
```
public List<Node> getSeqNodes()
```
    Returns the route sequence of traversed nodes (when a resource is traversed, the resource node is not added again as a traversal)
    
    Returns:
    
    see description above
  - getSeqOccupiedCapacitiesIfNotFailing
```
public List<Double> getSeqOccupiedCapacitiesIfNotFailing()
```
    Returns a list of double, with one element per link or resource traversed, in the order in which they are traversed, meaning the occupation in such traversal.
    
    Returns:
    
    the list of capacity occupations
  - getSeqResources
```
public static List<Resource> getSeqResources(List<? extends NetworkElement> seqLinksAndResources)
```
    Given a path, composed of a sequence of links and resources, extracts the list of resources, filtering out the links
    
    Parameters:
    
    seqLinksAndResources - sequence of links and resources
    
    Returns:
    
    the list of resources
  - getSeqResourcesTraversed
```
public List<Resource> getSeqResourcesTraversed()
```
    Returns the route current sequence of traversed resources, in the order they are traversed (and thus, a resource will appear as many times as it is traversed.
    
    Returns:
    
    the list
  - getSRGs
```
public SortedSet<SharedRiskGroup> getSRGs()
```
    Returns the SRGs the route is affected by (any traversed node or link is in the SRG)
    
    Returns:
    
    see description above
  - hasBackupRoutes
```
public boolean hasBackupRoutes()
```
    Returns true if this route has at least one backup route defined
    
    Returns:
    
    the info
  - hasLoops
```
public boolean hasLoops()
```
    Returns true if the route has loops (traverses a node more than once), and false otherwise
    
    Returns:
    
    see description above
  - isBackupRoute
```
public boolean isBackupRoute()
```
    Returns true if this route has been defined as a backup route for other
    
    Returns:
    
    the info
  - isBidirectional
```
public boolean isBidirectional()
```
    Returns true if the route is bidirectional. That is, it has an associated route in the other direction
    
    Returns:
    
    see above
  - isDown
```
public boolean isDown()
```
    Returns true if the route is traversing a link or node that is down. Returns false otherwise
    
    Returns:
    
    see description above
  - isOccupyingDifferentCapacitiesInDifferentLinksInNoFailureState
```
public boolean isOccupyingDifferentCapacitiesInDifferentLinksInNoFailureState()
```
  - isServiceChain
```
public boolean isServiceChain()
```
    Indicates if the route is a serivce chain: traverses resources
    
    Returns:
    
    see above
  - isTraversingZeroCapLinks
```
public boolean isTraversingZeroCapLinks()
```
    Returns true if the route is traversing a link with zero capacity
    
    Returns:
    
    see above
  - remove
```
public void remove()
```
    Removes this route.
  - removeBackupRoute
```
public void removeBackupRoute(Route backupRoute)
```
    Removes the given backupRoute from the backupRoute list of this route
    
    Parameters:
    
    backupRoute - The route to remove as backup
  - setBidirectionalPair
```
public void setBidirectionalPair(Route r)
```
    Sets the given route as the bidirectional pair of this route. If any of the routes was previously set as bidirectional pair of other route, such relation is removed. The routes demands must be bidirectional pairs of each other
    
    Parameters:
    
    r - the other route
  - setCarriedTraffic
```
public void setCarriedTraffic(double newCarriedTraffic,
                              double newOccupiedLinkAndResourcesCapacities)
```
    Sets the route carried traffic and the occupied capacity in the traversed links and resources (typically the same as the carried traffic), setting it to being the same in all the links and resources traversed. If the route is traversing a failing link or node, its current carried traffic and occupied link capacity will be still zero, but if the route becomes up later, its carried traffic and occupied link capacities will be the ones stated here.
    
    Parameters:
    
    newCarriedTraffic - the new carried traffic
    
    newOccupiedLinkAndResourcesCapacities - the new occuppied link and resourcs capacity
  - setCarriedTraffic
```
public void setCarriedTraffic(double newCarriedTraffic,
                              List<Double> linkAndResourcesOccupationInformation)
```
    Sets the route carried traffic and the occupied capacity in the traversed links and resources, so the capacity occupied can be different (but always non-negative) in each. If the route is traversing a failing link or node, its current carried traffic and occupied capacity will be still zero, but if the route becomes up later, its carried traffic and occupied link capacities will be the ones stated here.
    
    Parameters:
    
    newCarriedTraffic - the new carried traffic
    
    linkAndResourcesOccupationInformation - the new occupied capacity in traversed link and resources. If null, the occupied capacities are kept unchanged
  - setPath
```
public void setPath(double newCarriedTraffic,
                    List<? extends NetworkElement> newPath,
                    List<Double> newOccupationInformation)
```
    Sets the new sequence of links and/or resources traversed by the route, carried traffic, and occupied capacity in the traversed links/resources If the new route traverses failing link or nodes, its current carried traffic and occupied link capacities will be zero. If not, will be the base ones in the no failure state
    
    Parameters:
    
    newCarriedTraffic - new amount of carried traffic
    
    newPath - the new sequence of links and resources
    
    newOccupationInformation - the new link/resource occupation info
  - setSeqLinks
```
public void setSeqLinks(List<Link> seqLinks)
```
    Sets the new sequence of links traversed by the route. Since this method receives a list of links as input, the new route does not traverse resources. Thus, this method cannot be used in service chains. The route carried traffic is not changed. If the current occupied capacity in the traversed links is constant (not different link to link), this same amount is the occupied capacity in the links of the new path. If not, an exception is thrown (in this case, the setPath method should be used). As usual, if (while) the new route traverses failing link or nodes, its current carried traffic and occupied link capacities will be zero.
    
    Parameters:
    
    seqLinks - the new sequence of links and protection segments
  - toString
```
public String toString()
```
    Description copied from class: NetworkElement
    
    Returns a String representation of the network element.
    
    Overrides:
    
    toString in class NetworkElement
    
    Returns:
    
    String representation of the network element

Class Route

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

addBackupRoute

createBidirectionalOppositePair

getBackupRoutes

getBidirectionalPair

getCarriedTraffic

getCarriedTrafficInNoFailureState

getDemand

getEgressNode

getFirstAvailableNodeAfterFailures

getFirstAvailableNodeBeforeFailures

getIngressNode

getInitialState

getLayer

getLengthInKm

getNumberOfHops

getNumberOfTimesIsTraversed

getOccupiedCapacity

getOccupiedCapacityInNoFailureState

getOppositePath

getPath

getPropagationDelayInMiliseconds

getPropagationSpeedInKmPerSecond

getRoutesIAmBackup

getSeqIntermediateNodes

getSeqLinks

getSeqLinks

getSeqNodes

getSeqOccupiedCapacitiesIfNotFailing

getSeqResources

getSeqResourcesTraversed

getSRGs

hasBackupRoutes

hasLoops

isBackupRoute

isBidirectional

isDown

isOccupyingDifferentCapacitiesInDifferentLinksInNoFailureState

isServiceChain

isTraversingZeroCapLinks

remove

removeBackupRoute

setBidirectionalPair

setCarriedTraffic

setCarriedTraffic

setPath

setSeqLinks

toString