MulticastDemand (net2plan-javadoc 0.6.0.1 API)

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

All Implemented Interfaces:

Comparable<NetworkElement>
```
public class MulticastDemand
extends NetworkElement
```
This class contains a representation of a multicast demand. Multicast demands are defined by its initial node, a set of different end nodes (all different from the initial node)and end node, the network layer they belong to, and their offered traffic. Multicast demand traffic is carried through multicast trees with the same end nodes.

In multilayer designs, a multicast demand in a lower layer can be coupled to a set of links in the upper layer: one link between the demand initial node, and each demand end node. Then, the demand carried traffic is equal to the upper layer link capacities (thus, upper link capacity and lower layer demand traffic must be measured in the same units).

Since:

0.4.0

Author:

Pablo Pavon-Marino

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Pair<SortedSet<MulticastTree>,Double>`	`computeMinimumCostMulticastTrees(double[] costs)` Returns the multicast tree of this demand with lowest cost (and its cost), using the cost per link array provided.
`void`	`couple(Set<Link> links)` Couples this demand to the given `SortedSet` of `Links` in the upper layer.
`SortedSet<Link>`	`coupleToNewLinksCreated(NetworkLayer newLinkLayer)` Creates new links in the given layer, from the demand ingress node to each one of the demand egress nodes, and couples these newly created links to the multicast demand.
`void`	`decouple()` Decouples this mulicast demand from a set of upper layer `Links`.
`double`	`getBlockedTraffic()` Returns the blocked traffic of the demand (offered minus carried, or 0 if carried is above offered).
`double`	`getCarriedTraffic()` Returns the carried traffic of the demand, summing all the associated `Multicast Trees`
`SortedSet<Link>`	`getCoupledLinks()` Returns the `SortedSet` of `Links` this demand is coupled to, or an empty `SortedSet` if this demand is not coupled.
`SortedSet<Node>`	`getEgressNodes()` Returns the `SortedSet` of demand egress `Nodes`.
`Node`	`getIngressNode()` Returns the demand ingress Returns the demand ingress `Node`
`NetworkLayer`	`getLayer()` Returns the `NetworkLayer` object this element belongs to
`SortedSet<Link>`	`getLinksNoDownPropagationPotentiallyCarryingTraffic(Node egressNode)` Returns the set of links in this layer that could potentially carry traffic of this multicast demand, when flowing from the origin node to the given egress node, according to the multicast trees defined.
`double`	`getMaximumAcceptableE2EWorstCaseLatencyInMs()` Returns the maximum e2e latency registered as acceptable for the demand (in ms)
`TrafficSeries`	`getMonitoredOrForecastedOfferedTraffic()` Returns the object contianing the monitored or forecasted time series information for the offered traffic
`SortedSet<MulticastTree>`	`getMulticastTrees()` Returns the `Multicast Trees` associated to this demand.
`double`	`getOfferedTraffic()` Returns the offered traffic of the demand, in traffic units.
`double`	`getOfferedTrafficPerPeriodGrowthFactor()` Return the growth factor of the offered traffic in subsequent periods.
`String`	`getQosType()` Return the QoS type of the demand
`SortedMap<Link,Double>`	`getTraversedLinksAndCarriedTraffic(boolean normalizedToOfferedTraffic)` Returns a map with an entry for each traversed link, and associated to it the demand's traffic carried in that link.
`double`	`getWorseCasePropagationTimeInMs()` Returns the worse case end-to-end propagation time of the demand traffic.
`double`	`getWorstCaseLengthInKm()` Returns the worst case end-to-end length in km of this demand traffic.
`boolean`	`isAllTreesReachingAllEgressNodes()` Returns true if all the multicast trees of the demand, reach all the multicast demand egress nodes
`boolean`	`isBifurcated()` Returns `true` if more than one `Multicast Tree` is associated to the demand (trees with zero carried traffic, or that are down also count).
`boolean`	`isBlocked()` Returns `true` if the carried traffic is strictly less than the offered traffic, up to the Net2Plan precision factor.
`boolean`	`isCoupled()` Returns `true` if the demand is coupled.
`boolean`	`isTraversingOversubscribedLinks()` Returns `true` if the traffic of the demand is traversing an oversubscribed `Link`.
`void`	`remove()` Removes this multicast demand, and any associated multicast trees.
`void`	`setMaximumAcceptableE2EWorstCaseLatencyInMs(double maxLatencyMs)` Sets the maximum latency in ms acceptable for the demand.
`void`	`setMonitoredOrForecastedOfferedTraffic(TrafficSeries newTimeSeries)` Sets the new time series for the monitored or forecasted offered traffic, eliminating any previous values
`void`	`setOfferedTraffic(double offeredTraffic)` Sets the offered traffic by a multicast demand.
`void`	`setOfferedTrafficPerPeriodGrowthFactor(double growthFactor)` Sets the growth factor of the offered traffic in subsequent periods.
`void`	`setQoSType(String newQosType)` Sets the QoS type of the demand.
`String`	`toString()` Returns a `String` representation of the multicast demand.

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

- Method Detail
  - computeMinimumCostMulticastTrees
```
public Pair<SortedSet<MulticastTree>,Double> computeMinimumCostMulticastTrees(double[] costs)
```
    Returns the multicast tree of this demand with lowest cost (and its cost), using the cost per link array provided. If more than one minimum cost tree exists, all of them are returned. If the cost vector provided is null, all links are assigned a cost of one.
    
    Parameters:
    
    costs - Link weights
    
    Returns:
    
    A Pair where the first element is a SortedSet of minimum cost trees, and the second element is the common minimum cost
  - couple
```
public void couple(Set<Link> links)
```
    Couples this demand to the given SortedSet of Links in the upper layer. The number of links equals to the number of egress nodes of the demand. Links must start in the demand ingress node, and end in each of the multicast demand egress nodes.
    
    Important: This demand and the links must not be already coupled.
    
    Parameters:
    
    links - The set of links to couple to
  - coupleToNewLinksCreated
```
public SortedSet<Link> coupleToNewLinksCreated(NetworkLayer newLinkLayer)
```
    Creates new links in the given layer, from the demand ingress node to each one of the demand egress nodes, and couples these newly created links to the multicast demand.
    
    Parameters:
    
    newLinkLayer - The layer where the new links will be created
    
    Returns:
    
    The set of created links, already coupled to the demand
  - decouple
```
public void decouple()
```
    Decouples this mulicast demand from a set of upper layer Links. If the demand is not coupled, an exception is thrown
  - getBlockedTraffic
```
public double getBlockedTraffic()
```
    Returns the blocked traffic of the demand (offered minus carried, or 0 if carried is above offered).
    
    Returns:
    
    The blocked traffic
  - getCarriedTraffic
```
public double getCarriedTraffic()
```
    Returns the carried traffic of the demand, summing all the associated Multicast Trees
    
    Returns:
    
    The demand carried traffic, in traffic units
  - getCoupledLinks
```
public SortedSet<Link> getCoupledLinks()
```
    Returns the SortedSet of Links this demand is coupled to, or an empty SortedSet if this demand is not coupled.
    
    Returns:
    
    The SortedSet of links (a copy , any changes will not affect the coupling)
  - getEgressNodes
```
public SortedSet<Node> getEgressNodes()
```
    Returns the SortedSet of demand egress Nodes.
    
    Returns:
    
    The SortedSet of demand egress nodes as an unmodifiable set
  - getIngressNode
```
public Node getIngressNode()
```
    Returns the demand ingress Returns the demand ingress Node
    
    Returns:
    
    The ingress node
  - getLayer
```
public NetworkLayer getLayer()
```
    Returns the NetworkLayer object this element belongs to
    
    Returns:
    
    The NetworkLayer
  - getLinksNoDownPropagationPotentiallyCarryingTraffic
```
public SortedSet<Link> getLinksNoDownPropagationPotentiallyCarryingTraffic(Node egressNode)
```
    Returns the set of links in this layer that could potentially carry traffic of this multicast demand, when flowing from the origin node to the given egress node, according to the multicast trees defined. These are the links that are part of any path from demand ingress, the given egress node defined, in any multicast tree. If one of these paths contains a failed link, none of these links of such multicast tree are considered.
    
    Parameters:
    
    egressNode - the egress node
    
    Returns:
    
    see above
  - getMaximumAcceptableE2EWorstCaseLatencyInMs
```
public double getMaximumAcceptableE2EWorstCaseLatencyInMs()
```
    Returns the maximum e2e latency registered as acceptable for the demand (in ms)
    
    Returns:
    
    see above
  - getMonitoredOrForecastedOfferedTraffic
```
public TrafficSeries getMonitoredOrForecastedOfferedTraffic()
```
    Returns the object contianing the monitored or forecasted time series information for the offered traffic
    
    Returns:
    
    see above
  - getMulticastTrees
```
public SortedSet<MulticastTree> getMulticastTrees()
```
    Returns the Multicast Trees associated to this demand.
    
    Returns:
    
    The SortedSet of MulticastTree as an unmodifable set (empty if no trees exist)
  - getOfferedTraffic
```
public double getOfferedTraffic()
```
    Returns the offered traffic of the demand, in traffic units.
    
    Returns:
    
    The demand offered traffic
  - getOfferedTrafficPerPeriodGrowthFactor
```
public double getOfferedTrafficPerPeriodGrowthFactor()
```
    Return the growth factor of the offered traffic in subsequent periods.
    
    Returns:
    
    see above
  - getQosType
```
public String getQosType()
```
    Return the QoS type of the demand
    
    Returns:
    
    see above
  - getTraversedLinksAndCarriedTraffic
```
public SortedMap<Link,Double> getTraversedLinksAndCarriedTraffic(boolean normalizedToOfferedTraffic)
```
    Returns a map with an entry for each traversed link, and associated to it the demand's traffic carried in that link. If selected by the user, the carried traffic is given as a fraction respect to the demand offered traffic
    
    Parameters:
    
    normalizedToOfferedTraffic - see above
    
    Returns:
    
    see above
  - getWorseCasePropagationTimeInMs
```
public double getWorseCasePropagationTimeInMs()
```
    Returns the worse case end-to-end propagation time of the demand traffic. This is the worse end-to-end propagation time (summing the Link latencies) for each of the paths from the origin Node, to each output node, among all the Multicast Trees carrying traffic of this demand. In multilayer designs, when the traffic of a multicast tree traverses a link that is coupled to a lower layer demand, the link latency taken is the worse case propagation time of the underlying demand.
    
    Returns:
    
    The worse case propagation time in miliseconds
  - getWorstCaseLengthInKm
```
public double getWorstCaseLengthInKm()
```
    Returns the worst case end-to-end length in km of this demand traffic. This is the worse end-to-end length in km for each of the paths from the origin node to each output node, among all the trees carrying traffic of this demand. In multilayer designs, when the traffic of a multicast tree traverses a link that is coupled to a lower layer demand, the link length taken is the worst case length of the underlying demand.
    
    Returns:
    
    see above
  - isAllTreesReachingAllEgressNodes
```
public boolean isAllTreesReachingAllEgressNodes()
```
    Returns true if all the multicast trees of the demand, reach all the multicast demand egress nodes
    
    Returns:
    
    see above
  - isBifurcated
```
public boolean isBifurcated()
```
    Returns true if more than one Multicast Tree is associated to the demand (trees with zero carried traffic, or that are down also count).
    
    Returns:
    
    True if traffic is bifurcated between two or more multicast trees (see above), or false otherwise
  - isBlocked
```
public boolean isBlocked()
```
    Returns true if the carried traffic is strictly less than the offered traffic, up to the Net2Plan precision factor.
    
    Returns:
    
    True if the demand has blocked traffic, false otherwise
    
    See Also:
    
    Configuration
  - isCoupled
```
public boolean isCoupled()
```
    Returns true if the demand is coupled.
    
    Returns:
    
    true if the demand is coupled, false otherwise
  - isTraversingOversubscribedLinks
```
public boolean isTraversingOversubscribedLinks()
```
    Returns true if the traffic of the demand is traversing an oversubscribed Link.
    
    Returns:
    
    True if the traffic of the demand is traversing an oversubscribed, false otherwise
  - remove
```
public void remove()
```
    Removes this multicast demand, and any associated multicast trees. If the demand is coupled, it is first decoupled.
  - setMaximumAcceptableE2EWorstCaseLatencyInMs
```
public void setMaximumAcceptableE2EWorstCaseLatencyInMs(double maxLatencyMs)
```
    Sets the maximum latency in ms acceptable for the demand. A non-positive value is equivalent to no limit
    
    Parameters:
    
    maxLatencyMs - see above
  - setMonitoredOrForecastedOfferedTraffic
```
public void setMonitoredOrForecastedOfferedTraffic(TrafficSeries newTimeSeries)
```
    Sets the new time series for the monitored or forecasted offered traffic, eliminating any previous values
    
    Parameters:
    
    newTimeSeries - see above
  - setOfferedTraffic
```
public void setOfferedTraffic(double offeredTraffic)
```
    Sets the offered traffic by a multicast demand. This does not change the carried traffic, which only depends on the associated multicast trees.
    
    Parameters:
    
    offeredTraffic - Offered traffic
  - setOfferedTrafficPerPeriodGrowthFactor
```
public void setOfferedTrafficPerPeriodGrowthFactor(double growthFactor)
```
    Sets the growth factor of the offered traffic in subsequent periods. Offered traffic in period t+1, is the offered traffic in period t, multiplied by (1+growthFactor)
    
    Parameters:
    
    growthFactor - see above
  - setQoSType
```
public void setQoSType(String newQosType)
```
    Sets the QoS type of the demand. Any previous type is removed.
    
    Parameters:
    
    newQosType - see above
  - toString
```
public String toString()
```
    Returns a String representation of the multicast demand.
    
    Overrides:
    
    toString in class NetworkElement
    
    Returns:
    
    String representation of the multicast demand

Class MulticastDemand

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

computeMinimumCostMulticastTrees

couple

coupleToNewLinksCreated

decouple

getBlockedTraffic

getCarriedTraffic

getCoupledLinks

getEgressNodes

getIngressNode

getLayer

getLinksNoDownPropagationPotentiallyCarryingTraffic

getMaximumAcceptableE2EWorstCaseLatencyInMs

getMonitoredOrForecastedOfferedTraffic

getMulticastTrees

getOfferedTraffic

getOfferedTrafficPerPeriodGrowthFactor

getQosType

getTraversedLinksAndCarriedTraffic

getWorseCasePropagationTimeInMs

getWorstCaseLengthInKm

isAllTreesReachingAllEgressNodes

isBifurcated

isBlocked

isCoupled

isTraversingOversubscribedLinks

remove

setMaximumAcceptableE2EWorstCaseLatencyInMs

setMonitoredOrForecastedOfferedTraffic

setOfferedTraffic

setOfferedTrafficPerPeriodGrowthFactor

setQoSType

toString