SharedRiskGroup (net2plan-javadoc 0.6.0.1 API)

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

All Implemented Interfaces:

Comparable<NetworkElement>
```
public class SharedRiskGroup
extends NetworkElement
```
Author:

Pablo

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLink(Link link)` Adds a link to the SRG.
`void`	`addNode(Node node)` Adds a node to the SRG.
`boolean`	`affectsAnyOf(Collection<? extends NetworkElement> col)` Returns true if any element of the given collection of links, nodes and resources is affected by te SRG (fails if the SRG fails), false otherwise
`SortedSet<Link>`	`getAffectedLinks(NetworkLayer layer)` Returns all the links affected by this SRG, but only those at a particular layer.
`SortedSet<Link>`	`getAffectedLinksAllLayers()` Returns all the links affected by the SRG at all the layers: the links affected, and the input and output links of the affected nodes
`SortedSet<MulticastTree>`	`getAffectedMulticastTrees(NetworkLayer layer)` Returns the set of multicast trees in the given layer affected by the SRG (fail, when the SRG is in failure state)
`SortedSet<MulticastTree>`	`getAffectedMulticastTreesAllLayers()` Returns the set of multicast trees affected by the SRG (fail, when the SRG is in failure state).
`SortedSet<Route>`	`getAffectedRoutes(NetworkLayer layer)` Returns the set of routes in the given layer affected by the SRG (fail, when the SRG is in failure state)
`SortedSet<Route>`	`getAffectedRoutesAllLayers()` Returns the set of routes affected by the SRG (fail, when the SRG is in failure state).
`double`	`getAvailability()` Returns the availability (between 0 and 1) of the SRG.
`static SharedRiskGroup`	`getDummyEmptyStaticSrg(NetPlan np)`
`DynamicSrgImplementation`	`getDynamicSrgImplementation()` Returns the object implementing the dynamic decision of which nodes/links belong to this SRG
`SortedSet<Link>`	`getLinks(NetworkLayer layer)` Returns the set of links associated to the SRG (fail, when the SRG is in failure state), but only those belonging to the given layer.
`SortedSet<Link>`	`getLinksAllLayers()` Returns the set of links associated to the SRG (fail, when the SRG is in failure state).
`double`	`getMeanTimeToFailInHours()` Returns the mean time to fail (MTTF) in hours of the SRG, that is, the average time between when it is repaired, and its next failure.
`double`	`getMeanTimeToRepairInHours()` Returns the mean time to repair (MTTR) of the SRG, that is, the average time between a failure occurs, and it is repaired.
`SortedSet<Node>`	`getNodes()` Returns the set of nodes associated to the SRG (fail, when the SRG is in failure state)
`static SortedSet<SharedRiskGroup>`	`getSrgListCompletedWithDummyNoFailureStateIfNeeded(Collection<SharedRiskGroup> sourceSrgs, NetPlan np)`
`boolean`	`isDynamicCurrentlyEmptySrg()`
`boolean`	`isDynamicSrg()`
`boolean`	`isStaticEmptySrg()`
`void`	`remove()` Removes this SRG.
`void`	`removeLink(Link e)` Removes a link from the set of links of the SRG.
`void`	`removeNode(Node n)` Removes a node from the set of nodes of the SRG.
`void`	`setAsDown()` Sets nodes and links associated to the SRG as down (in case they are not yet).
`void`	`setAsUp()` Sets nodes and links associated to the SRG as up (in case they are not yet).
`void`	`setDynamicImplementation(DynamicSrgImplementation impl)`
`void`	`setMeanTimeToFailInHours(double value)` Sets the mean time to fail (MTTF) in hours of the SRG, that is, the average time between it is repaired, and the next failure.
`void`	`setMeanTimeToRepairInHours(double value)` Sets the mean time to repair (MTTR) in hours of the SRG, that is, the average time between a failure occurs, and it is repaired.
`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
  - addLink
```
public void addLink(Link link)
```
    Adds a link to the SRG. If the link is already part of the srg, no action is taken.
    
    Parameters:
    
    link - Link to add
  - addNode
```
public void addNode(Node node)
```
    Adds a node to the SRG. If the node is already part of the SRG, no action is taken
    
    Parameters:
    
    node - Node to add
  - affectsAnyOf
```
public boolean affectsAnyOf(Collection<? extends NetworkElement> col)
```
    Returns true if any element of the given collection of links, nodes and resources is affected by te SRG (fails if the SRG fails), false otherwise
    
    Parameters:
    
    col - the collection
    
    Returns:
    
    see above
  - getAffectedLinks
```
public SortedSet<Link> getAffectedLinks(NetworkLayer layer)
```
    Returns all the links affected by this SRG, but only those at a particular layer. This includes the links involved, and the input and output links of the affected nodes
    
    Parameters:
    
    layer - Network layer
    
    Returns:
    
    All the affected links at a given layer
  - getAffectedLinksAllLayers
```
public SortedSet<Link> getAffectedLinksAllLayers()
```
    Returns all the links affected by the SRG at all the layers: the links affected, and the input and output links of the affected nodes
    
    Returns:
    
    All the affected links
  - getAffectedMulticastTrees
```
public SortedSet<MulticastTree> getAffectedMulticastTrees(NetworkLayer layer)
```
    Returns the set of multicast trees in the given layer affected by the SRG (fail, when the SRG is in failure state)
    
    Parameters:
    
    layer - Network layer
    
    Returns:
    
    The failing multicast trees belonging to the given layer
  - getAffectedMulticastTreesAllLayers
```
public SortedSet<MulticastTree> getAffectedMulticastTreesAllLayers()
```
    Returns the set of multicast trees affected by the SRG (fail, when the SRG is in failure state).
    
    Returns:
    
    The set of failing multicast trees
  - getAffectedRoutes
```
public SortedSet<Route> getAffectedRoutes(NetworkLayer layer)
```
    Returns the set of routes in the given layer affected by the SRG (fail, when the SRG is in failure state)
    
    Parameters:
    
    layer - Network layer
    
    Returns:
    
    The failing routes belonging to that layer
  - getAffectedRoutesAllLayers
```
public SortedSet<Route> getAffectedRoutesAllLayers()
```
    Returns the set of routes affected by the SRG (fail, when the SRG is in failure state).
    
    Returns:
    
    The set of failing routes
  - getAvailability
```
public double getAvailability()
```
    Returns the availability (between 0 and 1) of the SRG. That is, the fraction of time that the SRG is in non failure state.
    
    Availability is computed as: MTTF/ (MTTF + MTTR)
    
    Returns:
    
    MTTF/ (MTTF + MTTR)
  - getDummyEmptyStaticSrg
```
public static SharedRiskGroup getDummyEmptyStaticSrg(NetPlan np)
```
  - getDynamicSrgImplementation
```
public DynamicSrgImplementation getDynamicSrgImplementation()
```
    Returns the object implementing the dynamic decision of which nodes/links belong to this SRG
    
    Returns:
    
    see above
  - getLinks
```
public SortedSet<Link> getLinks(NetworkLayer layer)
```
    Returns the set of links associated to the SRG (fail, when the SRG is in failure state), but only those belonging to the given layer.
    
    Parameters:
    
    layer - the layer
    
    Returns:
    
    The set of failing links
  - getLinksAllLayers
```
public SortedSet<Link> getLinksAllLayers()
```
    Returns the set of links associated to the SRG (fail, when the SRG is in failure state).
    
    Returns:
    
    The set of failing links, as an unmodifiable set
  - getMeanTimeToFailInHours
```
public double getMeanTimeToFailInHours()
```
    Returns the mean time to fail (MTTF) in hours of the SRG, that is, the average time between when it is repaired, and its next failure.
    
    Returns:
    
    The MTTF in hours
  - getMeanTimeToRepairInHours
```
public double getMeanTimeToRepairInHours()
```
    Returns the mean time to repair (MTTR) of the SRG, that is, the average time between a failure occurs, and it is repaired.
    
    Returns:
    
    the MTTR in hours
  - getNodes
```
public SortedSet<Node> getNodes()
```
    Returns the set of nodes associated to the SRG (fail, when the SRG is in failure state)
    
    Returns:
    
    The set of failing nodes, as an unmodifiable set
  - getSrgListCompletedWithDummyNoFailureStateIfNeeded
```
public static SortedSet<SharedRiskGroup> getSrgListCompletedWithDummyNoFailureStateIfNeeded(Collection<SharedRiskGroup> sourceSrgs,
                                                                                            NetPlan np)
```
  - isDynamicCurrentlyEmptySrg
```
public boolean isDynamicCurrentlyEmptySrg()
```
  - isDynamicSrg
```
public boolean isDynamicSrg()
```
  - isStaticEmptySrg
```
public boolean isStaticEmptySrg()
```
  - remove
```
public void remove()
```
    Removes this SRG.
  - removeLink
```
public void removeLink(Link e)
```
    Removes a link from the set of links of the SRG. If the link is not in the SRG, no action is taken
    
    Parameters:
    
    e - Link to be removed
  - removeNode
```
public void removeNode(Node n)
```
    Removes a node from the set of nodes of the SRG. If the node is not in the SRG, no action is taken
    
    Parameters:
    
    n - Node to be removed
  - setAsDown
```
public void setAsDown()
```
    Sets nodes and links associated to the SRG as down (in case they are not yet). The network state is updated with the affected routes, segments, trees and hop-by-hop routing associated to the new nodes/links down
  - setAsUp
```
public void setAsUp()
```
    Sets nodes and links associated to the SRG as up (in case they are not yet). The network state is updated with the affected routes, segments, trees and hop-by-hop routing associated to the new nodes/links down
  - setDynamicImplementation
```
public void setDynamicImplementation(DynamicSrgImplementation impl)
```
  - setMeanTimeToFailInHours
```
public void setMeanTimeToFailInHours(double value)
```
    Sets the mean time to fail (MTTF) in hours of the SRG, that is, the average time between it is repaired, and the next failure.
    
    Parameters:
    
    value - The new MTTF (it must be greater than zero)
  - setMeanTimeToRepairInHours
```
public void setMeanTimeToRepairInHours(double value)
```
    Sets the mean time to repair (MTTR) in hours of the SRG, that is, the average time between a failure occurs, and it is repaired.
    
    Parameters:
    
    value - the nnew MTTR (negative values are not accepted)
  - 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 SharedRiskGroup

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

addLink

addNode

affectsAnyOf

getAffectedLinks

getAffectedLinksAllLayers

getAffectedMulticastTrees

getAffectedMulticastTreesAllLayers

getAffectedRoutes

getAffectedRoutesAllLayers

getAvailability

getDummyEmptyStaticSrg

getDynamicSrgImplementation

getLinks

getLinksAllLayers

getMeanTimeToFailInHours

getMeanTimeToRepairInHours

getNodes

getSrgListCompletedWithDummyNoFailureStateIfNeeded

isDynamicCurrentlyEmptySrg

isDynamicSrg

isStaticEmptySrg

remove

removeLink

removeNode

setAsDown

setAsUp

setDynamicImplementation

setMeanTimeToFailInHours

setMeanTimeToRepairInHours

toString