NetPlan (net2plan-javadoc 0.6.0.1 API)

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

All Implemented Interfaces:

Comparable<NetworkElement>
```
public class NetPlan
extends NetworkElement
```
Class defining a complete multi-layer network structure. Layers may contain links, demands, routes or forwarding rules, while nodes and SRGs are defined with a network-wide scope, that is, they appear in all layers. To simplify handling of single-layer designs, methods that may refer to layer-specific elements have an optiona input parameter of type NetworkLayer. In case of not using this optional parameter, the action will be applied to the default layer (by default it is first defined layer), which can be modified using the setNetworkLayerDefault(NetworkLayer) setNetworkLayerDefault())} method.

Internal representation of the NetPlan object is based on:
- NetworkLayer objects.
- Node objects.
- Link objects.
- Route objects (depending on the selected Routing Type.
- Unicast or Multicast demand objects.
- Shared Risk Group objects
Each element has a unique identifier (represented as long) assigned the moment they are created, and two elements (irregardless of their type) cannot share this identifier. This id is incremental (but not necessarily consecutive) and perpetual (i.e after removing an element identifiers are no renumbered).

Also, elements have an index number that identify them among their own type (nodes, links, etc.). Indexes are renumbered when an element is removed and are zero base, that is the first element of its type is always 0 and the last is N-1 (where N is the total number of elements of the same type).

An instance of a NetPlan object can be set as unmodifiable through the setModifiableState(boolean) setModifiableState())} method. The instance will work transparently as NetPlan object unless you try to change it. Calling any method that can potentially change the network (e.g. add/set/remove methods) throws an UnsupportedOperationException.

Field Summary

Fields
Modifier and Type Field and Description

static String PLOTLAYTOUT_DEFAULTNODELAYOUTGUINAME

static String PLOTLAYTOUT_DEFAULTNODELAYOUTNAME

Fields
Modifier and Type	Field and Description
`static String`	`PLOTLAYTOUT_DEFAULTNODELAYOUTGUINAME`
`static String`	`PLOTLAYTOUT_DEFAULTNODELAYOUTNAME`

Constructor Summary

Constructors
Constructor and Description
`NetPlan()` Default constructor.
`NetPlan(File file)` Generates a new network design from a given `.n2p` file.
`NetPlan(InputStream inputStream)` Generates a new network design from an input stream.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Demand`	`addDemand(Node ingressNode, Node egressNode, double offeredTraffic, Constants.RoutingType routingType, Map<String,String> attributes, NetworkLayer... optionalLayerParameter)` Adds a new traffic demand.
`Pair<Demand,Demand>`	`addDemandBidirectional(Node ingressNode, Node egressNode, double offeredTraffic, Constants.RoutingType routingType, Map<String,String> attributes, NetworkLayer... optionalLayerParameter)` Adds two demands, one in each direction,.
`List<Demand>`	`addDemandsFromTrafficMatrix(DoubleMatrix2D trafficMatrix, Constants.RoutingType routingType, NetworkLayer... optionalLayerParameter)` Adds new traffic demands froma traffic matrix given as a `DoubleMatrix2D` object.
`void`	`addGlobalPlanningDomain(String planningDomain)` Adds a new planning domain to which elements can be assigned in the design.
`NetworkLayer`	`addLayer(String name, String description, String linkCapacityUnitsName, String demandTrafficUnitsName, URL defaultNodeIconURL, Map<String,String> attributes)` Adds a new layer.
`NetworkLayer`	`addLayerFrom(NetworkLayer origin)` Creates a new layer and adds the links, routes etc.
`Link`	`addLink(Node originNode, Node destinationNode, double capacity, double lengthInKm, double propagationSpeedInKmPerSecond, Map<String,String> attributes, NetworkLayer... optionalLayerParameter)` Adds a new link.
`Pair<Link,Link>`	`addLinkBidirectional(Node originNode, Node destinationNode, double capacity, double lengthInKm, double propagationSpeedInKmPerSecond, Map<String,String> attributes, NetworkLayer... optionalLayerParameter)` Adds two links, one in each direction.
`MulticastDemand`	`addMulticastDemand(Node ingressNode, Set<Node> egressNodes, double offeredTraffic, Map<String,String> attributes, NetworkLayer... optionalLayerParameter)` Adds a new multicast traffic demand.
`MulticastTree`	`addMulticastTree(MulticastDemand demand, double carriedTraffic, double occupiedLinkCapacity, Set<Link> linkSet, Map<String,String> attributes)` Adds a new traffic multicast tree.
`void`	`addMulticastTreesFromCandidateTreeList(SortedMap<MulticastDemand,List<SortedSet<Link>>> cpl)` Adds multiple multicast trees from a Candidate Tree list.
`Node`	`addNode(double xCoord, double yCoord, String name, Map<String,String> attributes)` Adds a new node to the network.
`void`	`addPlotNodeLayout(String newPlotNodeLayoutName)` Adds a new layout.
`Resource`	`addResource(String type, String name, Optional<Node> hostNode, double capacity, String capacityMeasurementUnits, Map<Resource,Double> capacityIOccupyInBaseResource, double processingTimeToTraversingTrafficInMs, Map<String,String> attributes)` Adds a new Resource to the network.
`Route`	`addRoute(Demand demand, double carriedTraffic, double occupiedLinkCapacity, List<Link> sequenceOfLinks, Map<String,String> attributes)` Adds a new traffic route
`void`	`addRoutesAndBackupRoutesFromCandidate11PathList(SortedMap<Pair<Node,Node>,List<Pair<List<Link>,List<Link>>>> cpl11, NetworkLayer... optionalLayer)` For each demand in the map, adds a number of route pairs with the given paths, where each route pair has a primary route and one backup to it.
`void`	`addRoutesFromCandidatePathList(SortedMap<Pair<Node,Node>,List<List<Link>>> cpl, NetworkLayer... optionalLayer)` Adds multiples routes for each demand of the given layer, using the paths in an input Candidate Path List.
`Route`	`addServiceChain(Demand demand, double carriedTraffic, List<Double> occupiedLinkAndResourceCapacities, List<? extends NetworkElement> sequenceOfLinksAndResources, Map<String,String> attributes)` Adds a new traffic service chain, which is a route which also traverses and occupied resources.
`SharedRiskGroup`	`addSRG(double mttfInHours, double mttrInHours, Map<String,String> attributes)` Adds a new SRG.
`SharedRiskGroup`	`addSRGDynamic(double mttfInHours, double mttrInHours, String className, String dynamicInitializationString, Map<String,String> attributes)` Adds a new dynamic SRG.
`void`	`assignFrom(NetPlan netPlan)` Assigns the information from the input `NetPlan`.
`void`	`checkCachesConsistency()` For debug purposes: Checks the consistency of the internal cache (nodes, srgs, resources, layers, links, demands, multicast demands, multicast trees, routes).
`NetworkLayer`	`checkContiguousPath(List<Link> links, NetworkLayer layer, Node originNode, Node destinationNode)` Checks that the input sequence of links belong to the same layer and follow a contiguous path.
`NetworkLayer`	`checkInThisNetPlanOptionalLayerParameter(NetworkLayer... optionalLayer)` Checks if the given layer is valid and belongs to this `NetPlan` design.
`DoubleMatrix1D`	`checkMatrixDemandLinkCarriedTrafficFlowConservationConstraints(DoubleMatrix2D x_de, boolean xdeValueAsFractionsRespectToDemandOfferedTraffic, NetworkLayer... optionalLayerParameter)` Checks the flow conservation constraints, and returns the traffic carried per demand.
`DoubleMatrix2D`	`checkMatrixDestinationLinkCarriedTrafficFlowConservationConstraints(DoubleMatrix2D x_te, NetworkLayer... optionalLayerParameter)` Checks the flow conservation constraints, and returns the traffic carried per input output node pair.
`SortedMap<MulticastDemand,List<SortedSet<Link>>>`	`computeMulticastCandidatePathList(DoubleMatrix1D costs, String solverName, String solverLibraryName, double maxSolverTimeInSecondsPerTree, String... candidateTreeListParamValuePairs)` The same as `computeMulticastCandidatePathList` for the default layer
`SortedMap<MulticastDemand,List<SortedSet<Link>>>`	`computeMulticastCandidatePathList(NetworkLayer layer, DoubleMatrix1D linkCosts, String solverName, String solverLibraryName, double maxSolverTimeInSecondsPerTree, String... candidateTreeListParamValuePairs)` Adds multicast trees specified by those trees that satisfy the options described below.
`DoubleMatrix1D`	`computeMulticastTreeCostVector(double[] costs, NetworkLayer... optionalLayerParameter)` Returns an array with the cost of each multicast tree in the layer.
`DoubleMatrix1D`	`computeRouteCostVector(double[] costs, NetworkLayer... optionalLayerParameter)` Returns an array with the cost of each route in the layer.
`static SortedMap<Pair<Node,Node>,List<Pair<List<Link>,List<Link>>>>`	`computeUnicastCandidate11PathList(Map<Pair<Node,Node>,List<List<Link>>> cpl, int disjointType)` Computes a list of disjoint path pairs for each node pair, using the paths in the input candidate path list given.
`static SortedMap<Demand,List<Pair<List<NetworkElement>,List<NetworkElement>>>>`	`computeUnicastCandidate11ServiceChainList(SortedMap<Demand,List<List<NetworkElement>>> cpl, int disjointType)` Computes a list of disjoint service chain pairs for each demand (service chain requests), using the service chain paths in the input candidate path list given.
`SortedMap<Pair<Node,Node>,List<List<Link>>>`	`computeUnicastCandidatePathList(DoubleMatrix1D linkCosts, int K, double maxLengthInKm, int maxNumHops, double maxPropDelayInMs, double maxRouteCost, double maxRouteCostFactorRespectToShortestPath, double maxRouteCostRespectToShortestPath, SortedSet<Pair<Node,Node>> nodePairs, NetworkLayer... optionalLayerParameter)` Computes for all the node pairs, a candidate path list in the given layer, composed of the k shortest paths according with the options indicated below.
`SortedMap<Demand,List<List<NetworkElement>>>`	`computeUnicastCandidateServiceChainList(DoubleMatrix1D linkCosts, DoubleMatrix1D resourceCosts, int K, double maxCostServiceChain, double maxLengthInKmPerSubpath, int maxNumHopsPerSubpath, double maxPropDelayInMsPerSubpath, NetworkLayer... optionalLayerParameter)` Computes for each demand (service chain request) up to k minimum cost service chain paths (sequence and links and resources), according to the link and resources cost information provided, as well as other constraints defined in the input parameters.
`NetPlan`	`copy()` Returns a deep copy of the current design.
`void`	`copyFrom(NetPlan originNetPlan)` Removes all information from the current `NetPlan` and copy the information from the input `NetPlan`.
`SortedMap<Link,SortedMap<String,Pair<Double,Double>>>`	`getAllLinksPerQosOccupationAndQosViolationMap(NetworkLayer... optionalLayerParameter)` For each link in the given layer, returns a map, with key the QoS types traversing it, and two associated values: (i) the total traffic occupied of such Qos type, (ii) the amount out of that traffic that is violating the QoS
`SortedSet<String>`	`getAllPlotNodeLayoutsDefined()` Returns all the names (identifiers) of the current node layout
`static SortedMap<NetworkElement,String>`	`getAttributes(Collection<? extends NetworkElement> collection, String attribute)` Returns the values of a given attribute for all the provided network elements.
`static DoubleMatrix1D`	`getAttributeValues(Collection<? extends NetworkElement> collection, String attributeName, double defaultValue)` Returns the values of a given attribute for all the provided network elements, as a `DoubleMatrix1D` vector.
`Demand`	`getDemand(int index, NetworkLayer... optionalLayerParameter)` Returns the demand with the given index.
`Demand`	`getDemandFromId(long uid)` Returns the demand with the given unique identifier.
`ArrayList<Long>`	`getDemandIds(NetworkLayer... optionalLayerParameter)` Returns the array of demand unique ids for the given layer (i-th position, corresponds to index i).
`List<Demand>`	`getDemands(NetworkLayer... optionalLayerParameter)` Returns the array of demands for the given layer (i-th position, corresponds to index i).
`List<Demand>`	`getDemandsBlocked(NetworkLayer... optionalLayerParameter)` Returns the demands that have blocked traffic in the given layer.
`SortedSet<Demand>`	`getDemandsCoupled(NetworkLayer... optionalLayerParameter)` Returns the set of unicast demands that are coupled.
`List<Demand>`	`getDemandsHopByHopRouted(NetworkLayer... optionalLayerParameter)` Returns the array of demands in the given layer that are hop-by-hop routed, ordered by its index.
`List<Demand>`	`getDemandsSourceRouted(NetworkLayer... optionalLayerParameter)` Returns the array of demands in the given layer that are source routed, ordered by its index.
`String`	`getDemandTrafficUnitsName(NetworkLayer... optionalLayerParameter)` Returns the name of the traffic units of the demands of the given layer.
`double`	`getForwardingRuleCarriedTraffic(Demand demand, Link link)` Returns the traffic that is carried using a forwarding rule, in the given layer.
`SortedMap<Pair<Demand,Link>,Double>`	`getForwardingRules(NetworkLayer... optionalLayerParameter)` Returns the forwarding rules for the given layer.
`double`	`getForwardingRuleSplittingFactor(Demand demand, Link link)` Returns the splitting factor of the forwarding rule of the given demand and link, which must be of the same layer.
`SortedSet<Node>`	`getGlobalPlanningDomainNodes(String planningDomain)` Returns the network elements associated to the given planning domain, or null if the planning domain was not defined
`SortedSet<String>`	`getGlobalPlanningDomains()` Returns the set of defined planning domains in this network design
`static Collection<Long>`	`getIds(Collection<? extends NetworkElement> collection)` Returns the unique ids of the provided network elements.
`static Collection<Integer>`	`getIndexes(Collection<? extends NetworkElement> collection)` Returns the indexes of the provided network elements.
`Link`	`getLink(int index, NetworkLayer... optionalLayerParameter)` Returns the link with the given index in the given layer.
`String`	`getLinkCapacityUnitsName(NetworkLayer... optionalLayerParameter)` Returns the name of the capacity units of the links of the given layer.
`Link`	`getLinkFromId(long uid)` Returns the link with the given unique identifier.
`ArrayList<Long>`	`getLinkIds(NetworkLayer... optionalLayerParameter)` Returns the array of link ids for the given layer (i-th position, corresponds to index i).
`List<Link>`	`getLinks(NetworkLayer... optionalLayerParameter)` Return a list of all the links in the given layer.
`SortedSet<Link>`	`getLinksAreBottleneck(NetworkLayer... optionalLayerParameter)` Returns the set of links that are a bottleneck, i.e the fraction of occupied capacity respect to the total is highest.
`SortedSet<Link>`	`getLinksCoupledToMulticastDemands(NetworkLayer... optionalLayerParameter)` Returns the set of links that are coupled to a multicast demand in the given layer.
`SortedSet<Link>`	`getLinksCoupledToUnicastDemands(NetworkLayer... optionalLayerParameter)` Returns the set of links that are couple to a unicast demand in the given layer.
`SortedSet<Link>`	`getLinksDown(NetworkLayer... optionalLayerParameter)` Returns the set of links that are down in the given layer.
`SortedSet<Link>`	`getLinksDownAllLayers()` Returns the set of links that are down in all layers.
`SortedSet<Link>`	`getLinksOversubscribed(NetworkLayer... optionalLayerParameter)` Returns the set of links oversuscribed: the total occupied capacity exceeds the link capacity.
`SortedSet<Link>`	`getLinksUp(NetworkLayer... optionalLayerParameter)` Returns the set of links that are up in the given layer.
`SortedSet<Link>`	`getLinksUpAllLayers()` Returns the set of links that are up in all layers.
`SortedSet<Link>`	`getLinksWithZeroCapacity(NetworkLayer... optionalLayerParameter)` Returns the set of links that have zero capacity in the given layer.
`DoubleMatrix2D`	`getMatrixDemand2LinkAssignment(NetworkLayer... optionalLayerParameter)` Returns the demand-link incidence matrix (a DxE matrix in which an element δ_de is equal to the number of times which traffic routes carrying traffic from demand d traverse link e).
`DoubleMatrix2D`	`getMatrixDemand2LinkTrafficCarried(SortedSet<Demand> demandsOfInterest, NetworkLayer... optionalLayerParameter)` Returns the demand-link incidence matrix (DxE in which an element δ_de is equal to the amount of traffic of each demand carried in each link).
`DoubleMatrix2D`	`getMatrixDemand2ResourceAssignment(NetworkLayer... optionalLayerParameter)` Returns the demand-resource incidence matrix, with as many rows as demands of the given layer, and a many colmns as resources, coordinate (d,r) equals the number of times that traffic routes of the demand d, traverse resource r.
`DoubleMatrix2D`	`getMatrixDemand2ResourceOccupiedCapacity(NetworkLayer... optionalLayerParameter)` Returns the demand-resource matrix, with as many rows as demands of the given layer, and as many columns as resources, coordinate (d,r) is the resource capacity that demand d currently occupies in resource r (recall that failed routes do not occupy capacity in the traversed resources).
`DoubleMatrix2D`	`getMatrixDemand2RouteAssignment(NetworkLayer... optionalLayerParameter)` Returns the demand-route incidence matrix (a DxR matrix in which an element δ_dr is equal to 1 if traffic route r is able to carry traffic from demand d).
`DoubleMatrix2D`	`getMatrixDemandBasedForwardingRules(NetworkLayer... optionalLayerParameter)` Returns the splitting ratio matrix (fractions of traffic entering a node from demand 'd', leaving that node through link 'e').
`DoubleMatrix2D`	`getMatrixDestination2LinkTrafficCarried(NetworkLayer... optionalLayerParameter)`
`DoubleMatrix2D`	`getMatrixDestinationBasedForwardingRules(NetworkLayer... optionalLayer)` A destination-based routing in the form of fractions f_te (fraction of the traffic targeted to node t that arrives (or is generated in) node a(e) (the initial node of link e), that is forwarded through link e).
`DoubleMatrix2D`	`getMatrixLink2LinkBidirectionalityMatrix(NetworkLayer... optionalLayerParameter)` Returns the link-link bidirectionality matrix (a ExE matrix where the element δ_ee' equals 1 when each position e and e' represent a bidirectional link at the given layer.
`DoubleMatrix2D`	`getMatrixLink2MulticastTreeAssignment(NetworkLayer... optionalLayerParameter)` Returns the link-multicast incidence matrix (an ExT matrix in which an element δ_et is equal to the number of times a multicast tree t traverse link e.
`DoubleMatrix2D`	`getMatrixLink2RouteAssignment(NetworkLayer... optionalLayerParameter)` Returns the link-route incidence matrix (an ExR matrix in which an element δ_ep is equal to the number of times which traffic route r traverses link e).
`DoubleMatrix2D`	`getMatrixLink2RouteFirstBackupRouteAssignment(NetworkLayer... optionalLayerParameter)` Returns a matrix with as many rows as links and as many columns as routes in the given layer, the position (e,r) contains the number of times that the first backup path of route r traveres link e
`DoubleMatrix2D`	`getMatrixLink2SRGAssignment(NetworkLayer... optionalLayerParameter)` Returns the link-srg assignment matrix (an ExS matrix in which an element δ_es equals 1 if link e fails when SRG s is affected.
`DoubleMatrix2D`	`getMatrixMulticastDemand2LinkAssignment(NetworkLayer... optionalLayerParameter)` Returns the multicast demand-link incidence matrix (a DxE matrix in which an element δ_de is equal to the number of times which multicast trees carrying traffic from demand d traverse link e).
`DoubleMatrix2D`	`getMatrixMulticastDemand2LinkTrafficCarried(NetworkLayer... optionalLayerParameter)` Returns the multicast demand-link incidence matrix (DxE in which an element δ_de is equal to the amount of traffic of each multicast demand carried in each link).
`DoubleMatrix2D`	`getMatrixMulticastDemand2MulticastTreeAssignment(NetworkLayer... optionalLayerParameter)` Returns the multicast demand-multicast tree incidence matrix (a DxT matrix in which an element δ_dt is equal to 1 if multicast tree t is able to carry traffic from multicast demand d).
`DoubleMatrix2D`	`getMatrixMulticastTree2SRGAffecting(NetworkLayer... optionalLayerParameter)` Returns the multicast tree-srg incidence matrix (an TxS matrix in which an element δ_ts equals 1 when multicast tree t fails when SRG s is affected.
`DoubleMatrix2D`	`getMatrixNode2NodeEuclideanDistance()` Returns the NxN Euclidean distance matrix (derived from node coordinates), where N is the number of nodes within the network.
`DoubleMatrix2D`	`getMatrixNode2NodeHaversineDistanceInKm()` Returns the NxN Haversine distance matrix (derived from node coordinates, where 'xCoord' is equal to longitude and 'yCoord' is equal to latitude), where N is the number of nodes within the network.
`DoubleMatrix2D`	`getMatrixNode2NodeOfferedTraffic(NetworkLayer... optionalLayerParameter)` Returns the traffic matrix, where rows and columns represent the ingress node and the egress node, respectively, in increasing order of identifier.
`DoubleMatrix2D`	`getMatrixNodeDemandAdjacency(NetworkLayer... optionalLayerParameter)` Returns a NxN matrix where each position accounts from the humber of demands that node i (row) as ingress node and j (column) as egress node.
`DoubleMatrix2D`	`getMatrixNodeDemandIncidence(NetworkLayer... optionalLayerParameter)` Returns the node-demand incidence matrix (a NxD in which an element δ_nd equals 1 if n is the ingress node of d, -1 if n is the egress node of d and 0 otherwise).
`DoubleMatrix2D`	`getMatrixNodeDemandIncomingIncidence(NetworkLayer... optionalLayerParameter)` Returns the node-demand incoming incidence matrix (a NxD matrix in which element δ_nd equals 1 if demand d is terminated in node n and 0 otherwise.
`DoubleMatrix2D`	`getMatrixNodeDemandOutgoingIncidence(NetworkLayer... optionalLayerParameter)` Returns the node-demand outgoing incidence matrix (a NxD matrix in which element δ_nd equals 1 if demand d is initiated in node n and 0 otherwise.
`DoubleMatrix2D`	`getMatrixNodeLinkAdjacency(NetworkLayer... optionalLayerParameter)` Returns the node-link adjacency matrix (a NxN matrix in which element δ_ij is equals to the number of links from node i to node j.
`DoubleMatrix2D`	`getMatrixNodeLinkIncidence(NetworkLayer... optionalLayerParameter)` Returns the node-link incidence matrix (a NxE matrix in which element δ_ne equals 1 if link e is initiated in node n, -1 if link e ends in node n, and 0 otherwise.
`DoubleMatrix2D`	`getMatrixNodeLinkIncomingIncidence(NetworkLayer... optionalLayerParameter)` Returns the node-link incoming incidence matrix (a NxE matrix in which element δ_ne equals 1 if link e is terminated in node n, and 0 otherwise.
`DoubleMatrix2D`	`getMatrixNodeLinkOutgoingIncidence(NetworkLayer... optionalLayerParameter)` Returns the node-link outgoing incidence matrix (a NxE matrix in which element δ_ne equals 1 if link e is initiated in node n, and 0 otherwise.
`DoubleMatrix2D`	`getMatrixNodeMulticastDemandAdjacency(NetworkLayer... optionalLayerParameter)` Returns a NxN matrix where each position accounts from the humber of multicast demands that node i (row) as ingress node and j (column) as an egress node.
`DoubleMatrix2D`	`getMatrixNodeMulticastDemandIncidence(NetworkLayer... optionalLayerParameter)` Returns the node-multicast demand incidence matrix (a NxD in which an element δ_nd equals 1 if n is the ingress node of d, -1 if n is an egress node of d and 0 otherwise).
`DoubleMatrix2D`	`getMatrixNodeMulticastDemandIncomingIncidence(NetworkLayer... optionalLayerParameter)` Returns the node-multicast demand incoming incidence matrix (a NxD matrix in which element δ_nd equals 1 if multicast demand d is terminated in node n and 0 otherwise.
`DoubleMatrix2D`	`getMatrixNodeMulticastDemandOutgoingIncidence(NetworkLayer... optionalLayerParameter)` Returns the node-multicast demand outgoing incidence matrix (a NxD matrix in which element δ_nd equals 1 if demand d is initiated in node n and 0 otherwise.
`DoubleMatrix2D`	`getMatrixResource2NodeAssignment()` Returns a matrix with as many rows resources, and columns as nodes.
`DoubleMatrix2D`	`getMatrixResource2ResourceType(String type)` Returns a matrix with as many rows resources as resources of the given type (ordered in an arbitrary form), and as many columns as resources in the network.
`DoubleMatrix2D`	`getMatrixResource2ResourceUpperToBaseAssignment()` Returns a matrix with as many rows and columns as resources.
`DoubleMatrix2D`	`getMatrixResource2ResourceUpperToBaseOccupation()` Returns a matrix with as many rows and columns as resources, coordinate (r1,r2) contains the capacity that resource r1 currently occupies in r2.
`DoubleMatrix2D`	`getMatrixResource2RouteAssignment(NetworkLayer... optionalLayerParameter)` Returns a matrix with as many rows resources, and columns as routes in the given layer, coordinate (res,rou) contains the number times that route rou traverses resource res.
`Pair<List<Resource>,DoubleMatrix2D>`	`getMatrixResource2RouteAssignment(String type, NetworkLayer... optionalLayerParameter)` Returns a matrix with as many rows resources, and columns as routes in the given layer, coordinate (res,rou) contains the number times that route rou traverses resource res.
`DoubleMatrix2D`	`getMatrixResource2RouteOccupation(NetworkLayer... optionalLayerParameter)` Returns a matrix with as many rows resources, and columns as routes in the given layer, and coordinate (res,rou) contains the capacity occupied by route rou in resource res (note that if a route is down, its occupied capacity in a resource becomes zero).
`DoubleMatrix2D`	`getMatrixResource2SRGAssignment()` Returns a matrix with as many rows resources, and columns as SRGs.
`DoubleMatrix2D`	`getMatrixRoute2SRGAffecting(NetworkLayer... optionalLayerParameter)` Returns the route-srg incidence matrix (an RxS matrix in which an element δ_rs equals 1 if route r fails when SRG s is affected.
`DoubleMatrix2D`	`getMatrixRouteFirstBackupRoute2SRGAffecting(NetworkLayer... optionalLayerParameter)` Returns a matrix with as many rows as routes of the given layer, and as many columns as SRGS.
`MulticastDemand`	`getMulticastDemand(int index, NetworkLayer... optionalLayerParameter)` Returns the multicast demand with the given index in the given layer.
`MulticastDemand`	`getMulticastDemandFromId(long uid)` Returns the multicast demand with the given unique identifier.
`ArrayList<Long>`	`getMulticastDemandIds(NetworkLayer... optionalLayerParameter)` Returns the array of multicast demand ids for the given layer (i-th position, corresponds to index i).
`List<MulticastDemand>`	`getMulticastDemands(NetworkLayer... optionalLayerParameter)` Returns the list of multicast demands for the given layer (i-th position, corresponds to multicast demand with index i).
`List<MulticastDemand>`	`getMulticastDemandsBlocked(NetworkLayer... optionalLayerParameter)` Returns the multicast demands that have blocked traffic in the given layer.
`MulticastTree`	`getMulticastTree(int index, NetworkLayer... optionalLayerParameter)` Returns the multicast tree with the given index in the given layer.
`MulticastTree`	`getMulticastTreeFromId(long uid)` Returns the multicast tree with the given unique identifier.
`ArrayList<Long>`	`getMulticastTreeIds(NetworkLayer... optionalLayerParameter)` Returns the array of multicast tree ids for the given layer (i-th position, corresponds to index i).
`List<MulticastTree>`	`getMulticastTrees(NetworkLayer... optionalLayerParameter)` Returns the array of multicast trees for the given layer (i-th position, corresponds to index i).
`SortedSet<MulticastTree>`	`getMulticastTreesDown(NetworkLayer... optionalLayerParameter)` Returns the set of multicast trees that are down (i.e.
`SortedSet<MulticastTree>`	`getMulticastTreesTraversingZeroCapLinks(NetworkLayer... optionalLayerParameter)` Returns the set of multicast trees that are down (i.e.
`NetworkElement`	`getNetworkElement(long id)` Return the network element with the given unique id.
`static NetworkElement`	`getNetworkElementByAttribute(Collection<? extends NetworkElement> listOfElements, String attribute, String value)` Returns the first network element among the ones passed as input parameters, that has the given key-value as attribute.
`long`	`getNetworkElementNextId()` Returns the next identifier for a new network element (layer, node, link, demand...)
`static Collection<? extends NetworkElement>`	`getNetworkElementsByAttribute(Collection<? extends NetworkElement> listOfElements, String attribute, String value)` Returns all the network elements among the ones passed as input parameters, that have the given key-value as attribute.
`NetworkLayer`	`getNetworkLayer(int index)` Returns the network layer with the given unique identifier.
`NetworkLayer`	`getNetworkLayer(String name)` Returns the network layer with the given name.
`NetworkLayer`	`getNetworkLayerDefault()` Return the default network layer.
`NetworkLayer`	`getNetworkLayerFromId(long uid)` Returns the network layer with the given unique identifier.
`ArrayList<Long>`	`getNetworkLayerIds()` Returns the array of layer ids (i-th position, corresponds to index i).
`List<NetworkLayer>`	`getNetworkLayerInTopologicalOrder()` Returns network layers in bottom-up order, that is, starting from the lower layers to the upper layers following coupling relationships.
`List<NetworkLayer>`	`getNetworkLayers()` Returns the array of network layers (i-th position, corresponds to index i).
`Node`	`getNode(int index)` Returns the node with the given index.
`Node`	`getNodeByName(String name)` Returns the first node with the given name.
`List<Node>`	`getNodeByNameAllNodes(String name)` Returns a list with all the nodes with the given name, or an empty list if none.
`Node`	`getNodeFromId(long uid)` Returns the node with the given unique identifier.
`ArrayList<Long>`	`getNodeIds()` Returns the array of node ids (i-th position, corresponds to index i)
`SortedSet<Demand>`	`getNodePairDemands(Node originNode, Node destinationNode, boolean returnDemandsInBothDirections, NetworkLayer... optionalLayerParameter)` Gets the set of demands at the given layer from the input nodes (if `returnDemandsInBothDirections` is `true`, also the reversed links are included).
`double`	`getNodePairEuclideanDistance(Node originNode, Node destinationNode)` Gets the Euclidean distance for a node pair.
`double`	`getNodePairHaversineDistanceInKm(Node originNode, Node destinationNode)` Gets the Haversine distance for a node pair.
`SortedSet<Link>`	`getNodePairLinks(Node originNode, Node destinationNode, boolean returnLinksInBothDirections, NetworkLayer... optionalLayerParameter)` Gets the set of links at the given layer from the given nodes (if `returnLinksInBothDirections` is `true`, also the reversed links are included).
`SortedSet<Route>`	`getNodePairRoutes(Node originNode, Node destinationNode, boolean returnRoutesInBothDirections, NetworkLayer... optionalLayerParameter)` Gets the set of routes at the given layer from the given nodes (if `returnRoutesInBothDirections` is `true`, also the reversed routes are included).
`List<Node>`	`getNodes()` Returns the array of nodes (i-th position, corresponds to index i).
`SortedSet<Node>`	`getNodesDown()` Returns the set of nodes that are down (iteration order corresponds to ascending order of indexes).
`SortedSet<Node>`	`getNodesUp()` Returns the set of nodes that are up (iteration order correspond to ascending order of indexes).
`int`	`getNumberOfDemands(NetworkLayer... optionalLayerParameter)` Returns the number of demands at the given layer.
`int`	`getNumberOfForwardingRules(NetworkLayer... optionalLayerParameter)` Returns the number of non-zero forwarding rules at the given layer.
`int`	`getNumberOfLayers()` Returns the number of layers defined.
`int`	`getNumberOfLinks(NetworkLayer... optionalLayerParameter)` Returns the number of links at the given layer.
`int`	`getNumberOfMulticastDemands(NetworkLayer... optionalLayerParameter)` Returns the number of multicast demands at the given layer.
`int`	`getNumberOfMulticastTrees(NetworkLayer... optionalLayerParameter)` Returns the number of multicast trees at the given layer.
`int`	`getNumberOfNodePairs()` Returns the number of node pairs.
`int`	`getNumberOfNodes()` Returns the number of network nodes,
`int`	`getNumberOfResources()` Returns the number of resources (Resource) defined
`int`	`getNumberOfRoutes(NetworkLayer... optionalLayerParameter)` Returns the number of routes at the given layer.
`int`	`getNumberOfSRGs()` Returns the number of shared risk groups (SRGs) defined
`String`	`getPlotNodeLayoutCurrentlyActive()` Returns the name (identifier) of the current node layout
`String`	`getPlotNodeLayoutDefaultLayoutName()` Returns the name of the default node layout (this is a constant).
`Resource`	`getResource(int index)` Returns the resource with the given index
`Resource`	`getResourceFromId(long uid)` Returns the resource with the given unique identifier.
`ArrayList<Long>`	`getResourceIds()` Returns the array of resource ids (i-th position, corresponds to index i)
`List<Resource>`	`getResources()` Returns the array of resources (i-th position, corresponds to index i).
`SortedSet<Resource>`	`getResources(String type)` Returns the set of resources in the network for the given type.
`SortedSet<Resource>`	`getResourcesAttachedToAnyNode()` Returns the set of resources which are attached to any node (that is, not unattached)
`Route`	`getRoute(int index, NetworkLayer... optionalLayerParameter)` Returns the route with the given index in the given layer.
`Route`	`getRouteFromId(long uid)` Returns the route with the given unique identifier.
`ArrayList<Long>`	`getRouteIds(NetworkLayer... optionalLayerParameter)` Returns the array of route ids for the given layer (i-th position, corresponds to index i).
`List<Route>`	`getRoutes(NetworkLayer... optionalLayerParameter)` Returns the array of route ids for the given layer (i-th position, corresponds to index i).
`List<Route>`	`getRoutesAreBackup(NetworkLayer... optionalLayerParameter)` Returns the list of routes which are not backup of any other route
`List<Route>`	`getRoutesAreNotBackup(NetworkLayer... optionalLayerParameter)` Returns the list of routes which are backup of any other route
`SortedSet<Route>`	`getRoutesDown(NetworkLayer... optionalLayerParameter)` Returns the set of routes that are down (traverse a link or node that is failed).
`SortedSet<Route>`	`getRoutesTraversingZeroCapacityLinks(NetworkLayer... optionalLayerParameter)` Returns the set of routes that are traversing a link with zero capacity.
`SortedSet<String>`	`getSiteNames()` Returns the set of all site names defined in the network
`SortedSet<Node>`	`getSiteNodes(String siteName)` Given a site name, returns the set of nodes associated to that site, or an empty set if none
`SharedRiskGroup`	`getSRG(int index)` Returns the shared risk group with the given index
`SharedRiskGroup`	`getSRGFromId(long uid)` Returns the shared risk group with the given unique identifier.
`ArrayList<Long>`	`getSRGIds()` Returns the array of shared risk group ids (i-th position, corresponds to index i)
`List<SharedRiskGroup>`	`getSRGs()` Returns the array of shared risk groups (i-th position, corresponds to index i).
`SortedSet<SharedRiskGroup>`	`getSrgsDynamic()` Returns the set of Srgs that are dynamically calculated
`SortedSet<Demand>`	`getTaggedDemands(String tag, NetworkLayer... optionalLayerParameter)` Returns the set of demands in the given layer with the given tag.
`SortedSet<NetworkLayer>`	`getTaggedLayers(String tag)` Returns the set of layers with the given tag.
`SortedSet<Link>`	`getTaggedLinks(String tag, NetworkLayer... optionalLayerParameter)` Returns the set of links in the given layer with the given tag.
`SortedSet<MulticastDemand>`	`getTaggedMulticastDemands(String tag, NetworkLayer... optionalLayerParameter)` Returns the set of multicast demands in the given layer with the given tag.
`SortedSet<MulticastTree>`	`getTaggedMulticastTrees(String tag, NetworkLayer... optionalLayerParameter)` Returns the set of multicast trees in the given layer with the given tag.
`SortedSet<Node>`	`getTaggedNodes(String tag)` Returns the set of nodes with the given tag.
`SortedSet<Resource>`	`getTaggedResources(String tag)` Returns the set of resources with the given tag.
`SortedSet<Route>`	`getTaggedRoutes(String tag, NetworkLayer... optionalLayerParameter)` Returns the set of routes in the given layer with the given tag.
`SortedSet<SharedRiskGroup>`	`getTaggedSrgs(String tag)` Returns the set of SRGs with the given tag.
`SortedSet<Resource>`	`getUnattachedResources()` Returns the set of resources which are not attached to any node
`DoubleMatrix1D`	`getVectorAttributeValues(Collection<? extends NetworkElement> collection, String attributeKey)` Retuns a vector with the values of all given network elements for the given attribute key.
`DoubleMatrix1D`	`getVectorDemandBlockedTraffic(NetworkLayer... optionalLayerParameter)` Returns a vector with the blocked traffic per demand, at the given layer.
`DoubleMatrix1D`	`getVectorDemandCarriedTraffic(NetworkLayer... optionalLayerParameter)` Returns a vector with the carried traffic per demand, at the given layer.
`DoubleMatrix1D`	`getVectorDemandOfferedTraffic(NetworkLayer... optionalLayerParameter)` Returns a vector with the offered traffic per demand, at the given layer.
`DoubleMatrix1D`	`getVectorDemandTraversesOversubscribedLink(NetworkLayer... optionalLayerParameter)` Returns a vector where each index equals the demand index and the value is 1 if said demand traverses oversubscrined links, 0 otherwise.
`DoubleMatrix1D`	`getVectorDemandWorseCasePropagationTimeInMs(NetworkLayer... optionalLayerParameter)` Returns the vector with the worst propagation time (in ms) per demand at the given layer.
`DoubleMatrix1D`	`getVectorLinkCapacity(NetworkLayer... optionalLayerParameter)` Returns a vector with the capacity per link, at the given layer.
`DoubleMatrix1D`	`getVectorLinkCarriedTraffic(NetworkLayer... optionalLayerParameter)` Returns a vector with the total carried traffic per link, at the given layer.
`DoubleMatrix1D`	`getVectorLinkLengthInKm(NetworkLayer... optionalLayerParameter)` Returns a vector with the length in km in the links, at the given layer.
`DoubleMatrix1D`	`getVectorLinkOccupiedCapacity(NetworkLayer... optionalLayerParameter)` Returns a vector with the total occupied capacity in the links, at the given layer.
`DoubleMatrix1D`	`getVectorLinkOversubscribedTraffic(NetworkLayer... optionalLayerParameter)` Returns a vector with the oversubscibed traffic (oversubscribed traffic being the sum of all carried traffic, minus the capacity, or 0 if such substraction is negative) in each link at the given layer.
`DoubleMatrix1D`	`getVectorLinkPropagationDelayInMiliseconds(NetworkLayer... optionalLayerParameter)` Returns a vector with the propagation delay in milliseconds in the links, at the given layer.
`DoubleMatrix1D`	`getVectorLinkPropagationSpeedInKmPerSecond(NetworkLayer... optionalLayerParameter)` Returns a vector with the propagation speed in km/s in the links, at the given layer.
`DoubleMatrix1D`	`getVectorLinkSpareCapacity(NetworkLayer... optionalLayerParameter)` Returns a vector with the spare capacity (available minus occupied, or zero if oversubscribed) per link, at the given layer.
`DoubleMatrix1D`	`getVectorLinkUpState(NetworkLayer... optionalLayerParameter)` Returns a vector with the up/down state in the links (1 up, 0 down), at the given layer.
`DoubleMatrix1D`	`getVectorLinkUtilization(NetworkLayer... optionalLayerParameter)` Returns a vector with the utilization per link, at the given layer.
`DoubleMatrix1D`	`getVectorMulticastDemandBlockedTraffic(NetworkLayer... optionalLayerParameter)` Returns a vector with the blocked traffic per multicast demand, at the given layer.
`DoubleMatrix1D`	`getVectorMulticastDemandCarriedTraffic(NetworkLayer... optionalLayerParameter)` Returns a vector with the carried traffic per multicast demand, at the given layer.
`DoubleMatrix1D`	`getVectorMulticastDemandOfferedTraffic(NetworkLayer... optionalLayerParameter)` Returns a vector with the offered traffic per multicast demand, at the given layer.
`DoubleMatrix1D`	`getVectorMulticastDemandTraversesOversubscribedLink(NetworkLayer... optionalLayerParameter)` Returns the vector indicating wheter a multicast demnd traverses (1) or not (0) oversubscribes links at the given layer.
`DoubleMatrix1D`	`getVectorMulticastDemandWorseCasePropagationTimeInMs(NetworkLayer... optionalLayerParameter)` Returns the vector with the worst propagation time (in ms) per multicast demand at the given layer.
`DoubleMatrix1D`	`getVectorMulticastTreeAverageNumberOfHops(NetworkLayer... optionalLayerParameter)` Returns a vector with the avergage number of hops per multicast tree at the given layer.
`DoubleMatrix1D`	`getVectorMulticastTreeCarriedTraffic(NetworkLayer... optionalLayerParameter)` Returns a vector with the carried traffic per multicast tree, at the given layer.
`DoubleMatrix1D`	`getVectorMulticastTreeNumberOfLinks(NetworkLayer... optionalLayerParameter)` Returns a vector with the number of links per multicast tree, at the given layer.
`DoubleMatrix1D`	`getVectorMulticastTreeOccupiedCapacity(NetworkLayer... optionalLayerParameter)` Returns a vector with the occupied capacity traffic per multicast tree, at the given layer.
`DoubleMatrix1D`	`getVectorMulticastTreeOfferedTrafficOfAssociatedMulticastDemand(NetworkLayer... optionalLayerParameter)` Returns a vector with the offered traffic per multicast tree from its associated multicast demand, at the given layer.
`DoubleMatrix1D`	`getVectorNodeEgressUnicastTraffic(NetworkLayer... optionalLayerParameter)` Returns the vector with the total incoming offered traffic per node at the given layer.
`DoubleMatrix1D`	`getVectorNodeIngressUnicastTraffic(NetworkLayer... optionalLayerParameter)` Returns the vector with the total outgoing offered traffic per node at the given layer.
`DoubleMatrix1D`	`getVectorNodePopulation()` Returns a vector with the population of the nodes.
`DoubleMatrix1D`	`getVectorNodeUpState()` Returns a vector with the up/down state of the nodes (1 up, 0 down).
`DoubleMatrix1D`	`getVectorResourceCapacity()` Returns a vector with as many elements as resources, containing the capacity (in the own resource capacity units), for each resource.
`DoubleMatrix1D`	`getVectorResourceIsOfType(String type)` Returns a vector with as many elements as resources, containing a 1 in coordinate of index i if the resource of index i is of the given type, a 0 if not.
`DoubleMatrix1D`	`getVectorResourceOccupiedCapacity()` Returns a vector with as many elements as resources, containing the currently occupied capacity (in the own resource capacity units), for each resource.
`DoubleMatrix1D`	`getVectorResourceProcessingTimeInMs()` Returns a vector with as many elements as resources, containing the processing time in ms for the traversig traffic, for each resource.
`DoubleMatrix1D`	`getVectorRouteCarriedTraffic(NetworkLayer... optionalLayerParameter)` Returns a vector with the carried traffic per route, at the given layer.
`DoubleMatrix1D`	`getVectorRouteFirstBackupRouteLengthInKm(NetworkLayer... optionalLayerParameter)` Returns a vector with one element per route, containing the length in km of the first defined backup path for such route.
`DoubleMatrix1D`	`getVectorRouteFirstBackupRouteNumberOfLinks(NetworkLayer... optionalLayerParameter)` Returns a vector with one element per route, containing the number of links of the first defined backup path for such route.
`DoubleMatrix1D`	`getVectorRouteLengthInKm(NetworkLayer... optionalLayerParameter)` Returns a vector with the length in km per route, at the given layer.
`DoubleMatrix1D`	`getVectorRouteNumberOfLinks(NetworkLayer... optionalLayerParameter)` Returns a vector with the number of links per route, at the given layer.
`DoubleMatrix1D`	`getVectorRouteOccupiedCapacity(NetworkLayer... optionalLayerParameter)` Returns a vector with the occupied capacity traffic per route, at the given layer.
`DoubleMatrix1D`	`getVectorRouteOfferedTrafficOfAssociatedDemand(NetworkLayer... optionalLayerParameter)` Returns a vector with the offered traffic (from its associated demand) per route at the given layer.
`DoubleMatrix1D`	`getVectorRoutePropagationDelayInMiliseconds(NetworkLayer... optionalLayerParameter)` Returns a vector with the propagation delay in seconds per route, at the given layer.
`DoubleMatrix1D`	`getVectorSRGAvailability()` Returns a vector with the availability per Shared Risk Group (SRG).
`boolean`	`hasDemands(NetworkLayer... optionalLayerParameter)` Returns `true` if the network has one or more demands at the given layer.
`boolean`	`hasForwardingRules(NetworkLayer... optionalLayerParameter)` Returns `true` if the network has at least one non-zero forwarding rule splitting ratio in any demand-link pair, in the given layer.
`boolean`	`hasLinks(NetworkLayer... optionalLayerParameter)` Returns `true` if the network has one or more links at the given layer.
`boolean`	`hasMulticastDemands(NetworkLayer... optionalLayerParameter)` Returns `true` if the network has one or more multicast demands at the given layer.
`boolean`	`hasMulticastTrees(NetworkLayer... optionalLayerParameter)` Returns `true` if the network has one or more multicast trees at the given layer.
`boolean`	`hasNodes()` Returns `true` if the network has nodes.
`boolean`	`hasResources()` Returns `true` if the network has one or more resources (Resource) defined.
`boolean`	`hasRoutes(NetworkLayer... optionalLayerParameter)` Returns `true` if the network has one or moreroutes at the given layer.
`boolean`	`hasSRGs()` Returns `true` if the network has one or more shared risk groups (SRGs) defined.
`boolean`	`hasUnicastRoutingLoops(NetworkLayer... optionalLayerParameter)` Returns `true` if the network has at least one routing cycle at the given layer.
`boolean`	`isDeepCopy(NetPlan np2)` Returns true if the given NetPlan object contains the same network than this, meaning that all the network elements are a copy in every aspect.
`boolean`	`isLayerCouplingValid(NetworkLayer lowerLayer, NetworkLayer upperLayer)` Indicates whether or not a further coupling between two layers would be valid.
`boolean`	`isModifiable()`
`boolean`	`isMulticastRoutingBifurcated(NetworkLayer... optionalLayerParameter)` Returns `true` if in the given layer, the traffic of any multicast demand is carried by more than one multicast tree.
`boolean`	`isMultilayer()` Returns `true` if the network has more than one layer.
`boolean`	`isSingleLayer()` Returns `true` if the network has just one layer
`boolean`	`isUnicastRoutingBifurcated(NetworkLayer... optionalLayerParameter)` Returns `true` if in the given layer, the traffic of any demand is carried by more than one route (in `SOURCE_ROUTING`), or a node sends traffic of a demand to more than one link (in `HOP_BY_HOP_ROUTING`).
`boolean`	`isUp(Collection<? extends NetworkElement> col)` Indicates whether or not a path, multicast tree or arbitrary collection of links and/or resources and/or nodes is up and belonging to this netPlan object (so they were not removed), and false otherwise
`static NetPlan`	`loadFromFile(File file)` Static factory method to get a `NetPlan` object from a `.n2p` file.
`NetPlan`	`mergeIntoThisDesign(NetPlan otherDesign)` Replaces the partition of the current design by this design.
`void`	`removeAllDemands(NetworkLayer... optionalLayerParameter)` Removes all the demands defined in the given layer.
`void`	`removeAllForwardingRules(NetworkLayer... optionalLayerParameter)` Removes all the forwarding rules in the given layer.
`void`	`removeAllLinks(NetworkLayer... optionalLayerParameter)` Removes all the links defined in the given layer.
`void`	`removeAllLinksUnused(double toleranceCapacityValueToConsiderUnusedLink, NetworkLayer... optionalLayerParameter)` Removes all the unsused links (those whith lesser capacity than `toleranceCapacityValueToConsiderUnusedLink`) defined in the given layer.
`void`	`removeAllMulticastDemands(NetworkLayer... optionalLayerParameter)` Removes all the multicast demands defined in the given layer.
`void`	`removeAllMulticastTrees(NetworkLayer... optionalLayerParameter)` Removes all the multicast trees defined in the given layer.
`void`	`removeAllMulticastTreesUnused(double toleranceTrafficAndCapacityValueToConsiderUnusedTree, NetworkLayer... optionalLayerParameter)` Removes all the multicast trees carrying no traffic and occupying no link capacity (even in the no failure state) defined in the given layer.
`void`	`removeAllNetworkLayers()` Removes all the network layers (everything but the nodes and the SRGs).
`void`	`removeAllNodes()` Removes all the network nodes.
`void`	`removeAllResources()` Removes all the resources.
`void`	`removeAllRoutes(NetworkLayer... optionalLayerParameter)` Removes all the routes defined in the given layer.
`void`	`removeAllRoutesUnused(double toleranceTrafficAndCapacityValueToConsiderUnusedRoute, NetworkLayer... optionalLayerParameter)` Removes all the routes defined in the given layer that do not carry traffic nor occupy link capacity in the given layer (even in a no-failure state).
`void`	`removeAllSRGs()` Removes all the shared risk groups.
`void`	`removeAllUnicastRoutingInformation(NetworkLayer... optionalLayerParameter)` Removes all the routing information (unicast and multicast) for the given layer, irrespective of the routing type setting.
`void`	`removeGlobalPlanningDomain(String planningDomain)` Removes a global planning domain, if no elements have it assigned, and there is left at least one planning domain
`void`	`removeNetworkLayer(NetworkLayer... optionalLayerParameter)` Removes a layer, and any associated link, demand, route, or forwarding rule.
`void`	`removePlotNodeLayout(String plotLayoutToRemove)` Removes the indicated layout, that cannot be the currently active layout, nor the default layout
`void`	`renameGlobalPlanningDomain(String oldName, String newName)` Change globally the name of a planning domain, updating the information in all the elements
`void`	`reset()` Resets the state of the network to an empty `NetPlan`.
`NetPlan`	`restrictDesign(SortedSet<Node> selectedNodes)` First computes the nodes to keep in the planning: these are the selected nodes, the nodes involved in the demands/mDemands between them in this layer, the nodes involved in the links at this layer that carry traffic between the selected nodes, and the nodes associated to the links/demands at lower layers, that carry the traffic between the selected nodes in the given layer, or carry traffic at lower layers, of the links at this layer between the selected nodes.
`void`	`saveToFile(File file)` Saves the current network plan to a given file.
`void`	`saveToOutputStream(OutputStream outputStream)` Saves the current network plan to a given output stream.
`void`	`setAllLinksFailureState(boolean setAsUp, NetworkLayer... optionalLayerParameter)` Sets the failure state (up or down) for all the links in the given layer.
`void`	`setAllNodesFailureState(boolean setAsUp)` Sets the failure state (up or down) for all the nodes.
`void`	`setDemandTrafficUnitsName(String demandTrafficUnitsName, NetworkLayer... optionalLayerParameter)` Sets the name of the units in which the offered traffic is measured (e.g.
`double`	`setForwardingRule(Demand demand, Link link, double splittingRatio)` Adds a new forwarding rule (or override an existing one), to the layer of the demand and link (must be in the same layer).
`void`	`setForwardingRules(Collection<Demand> demands, Collection<Link> links, Collection<Double> splittingFactors, boolean removePreviousRulesAffectedDemands)` Adds a set of forwarding rules (or override existing ones).
`void`	`setForwardingRules(DoubleMatrix2D f_de, Set<Demand> demandsToUpdate, NetworkLayer... optionalLayerParameter)` Sets the forwarding rules for the given design, only for the demands that are hop-by-hop.
`void`	`setLinkCapacityUnitsName(String name, NetworkLayer... optionalLayerParameter)` Sets the name of the units in which the link capacity is measured (e.g.
`void`	`setLinksAndNodesFailureState(Collection<Link> linksToSetAsUp, Collection<Link> linksToSetAsDown, Collection<Node> nodesToSetAsUp, Collection<Node> nodesToSetAsDown)` Changes the failure state of the links and updates the routes/trees (they do not carry traffic nor occupy capacity), and hop-by-hop routing (no traffic is forwarded in links down)
`boolean`	`setModifiableState(boolean isModifiable)` Sets the `NetPlan` so it cannot be modified
`void`	`setNetworkLayerDefault(NetworkLayer layer)` Sets the default network layer.
`void`	`setPlotNodeLayoutCurrentlyActive(String newCurrentPlotNodeLayout)` Returns all the names (identifiers) of the current node layout
`void`	`setRoutingFromDemandLinkCarriedTraffic(DoubleMatrix2D x_de, boolean xdeValueAsFractionsRespectToDemandOfferedTraffic, boolean removeCycles, Set<Demand> demandsToSetRouting, NetworkLayer... optionalLayerParameter)` Adds traffic routes (or forwarding rules, depending on the routing type) from demand-link routing at the given layer.
`void`	`setRoutingFromDestinationLinkCarriedTraffic(DoubleMatrix2D x_te, boolean removeCycles, NetworkLayer... optionalLayerParameter)` Adds traffic routes (or forwarding rules, depending on the routing type) from destination-link routing at the given layer.
`void`	`setRoutingTypeAllDemands(Constants.RoutingType newRoutingType, NetworkLayer... optionalLayerParameter)` Sets the routing type at the given layer.
`void`	`setTrafficMatrix(DoubleMatrix2D trafficMatrix, Constants.RoutingType routingTypeDemands, NetworkLayer... optionalLayerParameter)` Sets the traffic demands at the given layer from a given traffic matrix, removing any previous demand.
`void`	`setVectorAttributeValues(Collection<? extends NetworkElement> collection, String attributeKey, DoubleMatrix1D values)` Sets the given attributes values to all the given network elements.
`void`	`setVectorDemandOfferedTraffic(DoubleMatrix1D offeredTrafficVector, NetworkLayer... optionalLayerParameter)` Sets the vector of the offered traffic per demand, at the given layer.
`void`	`setVectorLinkCapacity(DoubleMatrix1D linkCapacities, NetworkLayer... optionalLayerParameter)` Sets the vector of the link capacities, at the given layer.
`void`	`setVectorMulticastDemandOfferedTraffic(DoubleMatrix1D offeredTrafficVector, NetworkLayer... optionalLayerParameter)` Sets the vector of the offered traffic per multicast demand, at the given layer.
`void`	`setVectorMulticastTreeCarriedTrafficAndOccupiedLinkCapacities(DoubleMatrix1D carriedTraffic, DoubleMatrix1D occupiedLinkCapacity, NetworkLayer... optionalLayerParameter)` Sets the vector of the multicast trees carried traffics and occupied link capacities, at the given layer.
`void`	`setVectorRouteCarriedTrafficAndOccupiedLinkCapacities(DoubleMatrix1D carriedTraffic, DoubleMatrix1D occupiedLinkCapacity, NetworkLayer... optionalLayerParameter)` Sets the vector of the route carried traffics and occupied link capacities, at the given layer.
`String`	`toString()` Returns a `String` representation of the network design.
`String`	`toString(Collection<NetworkLayer> layers)` Returns a `String` representation of the network design only for the given layers.

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

- Field Detail
  - PLOTLAYTOUT_DEFAULTNODELAYOUTGUINAME
```
public static final String PLOTLAYTOUT_DEFAULTNODELAYOUTGUINAME
```
    See Also:
    
    Constant Field Values
  - PLOTLAYTOUT_DEFAULTNODELAYOUTNAME
```
public static final String PLOTLAYTOUT_DEFAULTNODELAYOUTNAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NetPlan
```
public NetPlan()
```
    Default constructor. Creates an empty design
    
    Since:
    
    0.4.0
  - NetPlan
```
public NetPlan(File file)
```
    Generates a new network design from a given .n2p file.
    
    Parameters:
    
    file - .n2p file
    
    Since:
    
    0.2.0
  - NetPlan
```
public NetPlan(InputStream inputStream)
```
    Generates a new network design from an input stream.
    
    Parameters:
    
    inputStream - Input stream
    
    Since:
    
    0.3.1
- Method Detail
  - addDemand
```
public Demand addDemand(Node ingressNode,
                        Node egressNode,
                        double offeredTraffic,
                        Constants.RoutingType routingType,
                        Map<String,String> attributes,
                        NetworkLayer... optionalLayerParameter)
```
    Adds a new traffic demand.
    
    Important: Self-demands are not allowed.
    
    Parameters:
    
    ingressNode - Ingress node
    
    egressNode - Egress node
    
    offeredTraffic - Offered traffic by this demand. It must be greater or equal than zero
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    routingType - Routing type
    
    optionalLayerParameter - Network layer to which add the demand (optional)
    
    Returns:
    
    The newly added demand object
  - addDemandBidirectional
```
public Pair<Demand,Demand> addDemandBidirectional(Node ingressNode,
                                                  Node egressNode,
                                                  double offeredTraffic,
                                                  Constants.RoutingType routingType,
                                                  Map<String,String> attributes,
                                                  NetworkLayer... optionalLayerParameter)
```
    Adds two demands, one in each direction,.
    
    Important: Self-demands are not allowed.
    
    Parameters:
    
    ingressNode - Identifier of the ingress node
    
    egressNode - Identifier of the egress node
    
    offeredTraffic - Offered traffic by this demand. It must be greater or equal than zero
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    optionalLayerParameter - Network layer to which add the demand (optional)
    
    routingType - Routing type
    
    Returns:
    
    A pair object with the two newly created demands
    
    See Also:
    
    Demand, Pair
  - addDemandsFromTrafficMatrix
```
public List<Demand> addDemandsFromTrafficMatrix(DoubleMatrix2D trafficMatrix,
                                                Constants.RoutingType routingType,
                                                NetworkLayer... optionalLayerParameter)
```
    Adds new traffic demands froma traffic matrix given as a DoubleMatrix2D object. Previous demands are not removed.
    
    Parameters:
    
    trafficMatrix - Traffix matrix where i-th row is the ingress node, the j-th column the egress node and each entry the offered traffic
    
    routingType - Routing type
    
    optionalLayerParameter - Network layer to which to add the demands (optional)
    
    Returns:
    
    A list with the newly created demands
  - addGlobalPlanningDomain
```
public void addGlobalPlanningDomain(String planningDomain)
```
    Adds a new planning domain to which elements can be assigned in the design. If the planning domain already exists, an exception is raised
    
    Parameters:
    
    planningDomain - the name of the planning domain
  - addLayer
```
public NetworkLayer addLayer(String name,
                             String description,
                             String linkCapacityUnitsName,
                             String demandTrafficUnitsName,
                             URL defaultNodeIconURL,
                             Map<String,String> attributes)
```
    Adds a new layer.
    
    Parameters:
    
    name - Layer name (null means empty)
    
    description - Layer description (null means empty)
    
    linkCapacityUnitsName - Textual description of link capacity units (null means empty)
    
    demandTrafficUnitsName - Textual description of demand traffic units (null means empty)
    
    defaultNodeIconURL - The URL of the default icon for the layer nodes
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    Returns:
    
    The newly created layer object
  - addLayerFrom
```
public NetworkLayer addLayerFrom(NetworkLayer origin)
```
    Creates a new layer and adds the links, routes etc. from the input layer. The number of nodes in the two designs must be the same (the unique ids may differ). Any coupling information in the origin layer is omitted. Links, demands, multicast demands, routes and multicast trees will have the same index within the layer in the origin and in the copied layers, but may have different unique ids.
    
    Parameters:
    
    origin - Layer to be copied
    
    Returns:
    
    The newly created layer object
    
    See Also:
    
    NetworkLayer, Node
  - addLink
```
public Link addLink(Node originNode,
                    Node destinationNode,
                    double capacity,
                    double lengthInKm,
                    double propagationSpeedInKmPerSecond,
                    Map<String,String> attributes,
                    NetworkLayer... optionalLayerParameter)
```
    Adds a new link.
    
    Important: Self-links are not allowed.
    
    Parameters:
    
    originNode - Link origin node
    
    destinationNode - Link destination node
    
    capacity - Link capacity. It must be greather or equal to zero
    
    lengthInKm - Link length. It must be greater or equal than zero. Physical distance between node pais can be otainer through the getNodePairEuclideanDistance (for Euclidean distance) or getNodePairHaversineDistanceInKm (for airlinea distance) methods.
    
    propagationSpeedInKmPerSecond - Link propagation speed in km/s. It must be greater than zero (Double.MAX_VALUE means no propagation delay, a non-positive value is changed into 200000 km/seg, a typical speed of light in the wires)
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    optionalLayerParameter - Network layer to which add the link (optional)
    
    Returns:
    
    The newly created link object
    
    See Also:
    
    Link, Node
  - addLinkBidirectional
```
public Pair<Link,Link> addLinkBidirectional(Node originNode,
                                            Node destinationNode,
                                            double capacity,
                                            double lengthInKm,
                                            double propagationSpeedInKmPerSecond,
                                            Map<String,String> attributes,
                                            NetworkLayer... optionalLayerParameter)
```
    Adds two links, one in each direction.
    
    Important: Self-links are not allowed.
    
    Parameters:
    
    originNode - Link origin node
    
    destinationNode - Link destination node
    
    capacity - Link capacity. It must be greather or equal to zero
    
    lengthInKm - Link length. It must be greater or equal than zero. Physical distance between node pais can be otainer through the getNodePairEuclideanDistance (for Euclidean distance) or getNodePairHaversineDistanceInKm (for airlinea distance) methods.
    
    propagationSpeedInKmPerSecond - Link propagation speed in km/s. It must be greater than zero (Double.MAX_VALUE means no propagation delay, a non-positive value is changed into 200000 km/seg, a typical speed of light in the wires)
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    optionalLayerParameter - Network layer to which add the links (optional)
    
    Returns:
    
    A Pair object with the two newly created links
    
    See Also:
    
    Link, Pair, Node
  - addMulticastDemand
```
public MulticastDemand addMulticastDemand(Node ingressNode,
                                          Set<Node> egressNodes,
                                          double offeredTraffic,
                                          Map<String,String> attributes,
                                          NetworkLayer... optionalLayerParameter)
```
    Adds a new multicast traffic demand.
    
    Important: Ingress node cannot be also an egress node.
    
    Parameters:
    
    ingressNode - Ingress node
    
    egressNodes - Egress node
    
    offeredTraffic - Offered traffic of the demand. It must be greater or equal than zero
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    optionalLayerParameter - Network layer to which add the demand (optional)
    
    Returns:
    
    The newly created multicast demand
    
    See Also:
    
    MulticastDemand, Node
  - addMulticastTree
```
public MulticastTree addMulticastTree(MulticastDemand demand,
                                      double carriedTraffic,
                                      double occupiedLinkCapacity,
                                      Set<Link> linkSet,
                                      Map<String,String> attributes)
```
    Adds a new traffic multicast tree.
    
    Important: Routing type must be SOURCE_ROUTING.
    
    Parameters:
    
    demand - Multi cast demand to be associated with the tree
    
    carriedTraffic - Carried traffic. It must be greater or equal than zero
    
    occupiedLinkCapacity - Occupied link capacity. If -1, it will be assumed to be equal to the carried traffic. Otherwise, it must be greater or equal than zero
    
    linkSet - SortedSet of links of the multicast tree
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    Returns:
    
    The newly created multicast tree
    
    See Also:
    
    MulticastTree, MulticastDemand, Link
  - addMulticastTreesFromCandidateTreeList
```
public void addMulticastTreesFromCandidateTreeList(SortedMap<MulticastDemand,List<SortedSet<Link>>> cpl)
```
    Adds multiple multicast trees from a Candidate Tree list.
    
    Parameters:
    
    cpl - SortedMap where the keys are multicast demands and the values lists of link sets
    
    See Also:
    
    MulticastDemand, Link
  - addNode
```
public Node addNode(double xCoord,
                    double yCoord,
                    String name,
                    Map<String,String> attributes)
```
    Adds a new node to the network. Nodes are associated to all layers.
    
    Parameters:
    
    xCoord - Node position in x-axis
    
    yCoord - Node position in y-axis
    
    name - Node name (null will be converted to "Node " + node identifier)
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    Returns:
    
    The newly created node object
    
    See Also:
    
    Node
  - addPlotNodeLayout
```
public void addPlotNodeLayout(String newPlotNodeLayoutName)
```
    Adds a new layout. The positions in the new layout for all the nodes, are their positions at the currently active layout
    
    Parameters:
    
    newPlotNodeLayoutName - the new layout id
  - addResource
```
public Resource addResource(String type,
                            String name,
                            Optional<Node> hostNode,
                            double capacity,
                            String capacityMeasurementUnits,
                            Map<Resource,Double> capacityIOccupyInBaseResource,
                            double processingTimeToTraversingTrafficInMs,
                            Map<String,String> attributes)
```
    Adds a new Resource to the network. Resources are associated to a node, and have no layer associated to it.
    
    Parameters:
    
    type - The resource type
    
    name - The resource name
    
    hostNode - The node hosting the resource
    
    capacity - The capacity of the resource
    
    capacityMeasurementUnits - The units in which the resource capacity is measured
    
    capacityIOccupyInBaseResource - A map with a key per base resource (a resource in the same node in which this resource occupies capacity), and the value the capacity that this resource occupies in the base resource (key), in base resource capacity units
    
    processingTimeToTraversingTrafficInMs - The time in ms that takes the traffic traverse this resource
    
    attributes - The resource attributes
    
    Returns:
    
    The created Resource object
  - addRoute
```
public Route addRoute(Demand demand,
                      double carriedTraffic,
                      double occupiedLinkCapacity,
                      List<Link> sequenceOfLinks,
                      Map<String,String> attributes)
```
    Adds a new traffic route
    
    Important: Routing type must be SOURCE_ROUTING.
    
    Parameters:
    
    demand - Demand associated to the route
    
    carriedTraffic - Carried traffic. It must be greater or equal than zero
    
    occupiedLinkCapacity - Occupied link capacity, it must be greater or equal than zero.
    
    sequenceOfLinks - Sequence of links traversed by the route
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    Returns:
    
    The newly created route object
    
    See Also:
    
    Route, Demand, Link
  - addRoutesAndBackupRoutesFromCandidate11PathList
```
public void addRoutesAndBackupRoutesFromCandidate11PathList(SortedMap<Pair<Node,Node>,List<Pair<List<Link>,List<Link>>>> cpl11,
                                                            NetworkLayer... optionalLayer)
```
    For each demand in the map, adds a number of route pairs with the given paths, where each route pair has a primary route and one backup to it. All routes have zero carried traffic and zero occupied capacity in the links
    
    Parameters:
    
    cpl11 - a map with the path info
    
    optionalLayer - the layer (optional)
  - addRoutesFromCandidatePathList
```
public void addRoutesFromCandidatePathList(SortedMap<Pair<Node,Node>,List<List<Link>>> cpl,
                                           NetworkLayer... optionalLayer)
```
    Adds multiples routes for each demand of the given layer, using the paths in an input Candidate Path List. The paths should use the links of the same layer
    
    Parameters:
    
    cpl - SortedMap where the keys are the node pairs and the values a list of sequence of links (each sequence is a route)
    
    optionalLayer - the layer (optional)
  - addServiceChain
```
public Route addServiceChain(Demand demand,
                             double carriedTraffic,
                             List<Double> occupiedLinkAndResourceCapacities,
                             List<? extends NetworkElement> sequenceOfLinksAndResources,
                             Map<String,String> attributes)
```
    Adds a new traffic service chain, which is a route which also traverses and occupied resources.
    
    Important: Routing type must be SOURCE_ROUTING.
    
    Parameters:
    
    demand - Demand associated to the route
    
    carriedTraffic - Carried traffic. It must be greater or equal than zero
    
    occupiedLinkAndResourceCapacities - Occupied link capacity, it must be greater or equal than zero.
    
    sequenceOfLinksAndResources - Sequence of Link and Resource objects defining the sequence traversed by the route
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    Returns:
    
    The newly created route object
  - addSRG
```
public SharedRiskGroup addSRG(double mttfInHours,
                              double mttrInHours,
                              Map<String,String> attributes)
```
    Adds a new SRG.
    
    Parameters:
    
    mttfInHours - Mean Time To Fail (in hours). Must be greater than zero
    
    mttrInHours - Mean Time To Repair (in hours). Must be greater than zero
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    Returns:
    
    The newly created shared risk group object
    
    See Also:
    
    SharedRiskGroup
  - addSRGDynamic
```
public SharedRiskGroup addSRGDynamic(double mttfInHours,
                                     double mttrInHours,
                                     String className,
                                     String dynamicInitializationString,
                                     Map<String,String> attributes)
```
    Adds a new dynamic SRG. This is a SRG for which the set of links and nodes affected are dynamically computed everytime the get methods asking for them are called.
    
    Parameters:
    
    mttfInHours - Mean Time To Fail (in hours). Must be greater than zero
    
    mttrInHours - Mean Time To Repair (in hours). Must be greater than zero
    
    className - the name of the class implementing the dynamic SRG functionality
    
    dynamicInitializationString - the initialization string to be consumed by the dynami SRG implementation
    
    attributes - SortedMap for user-defined attributes (null means 'no attribute'). Each key represents the attribute name, whereas value represents the attribute value
    
    Returns:
    
    see above
  - assignFrom
```
public void assignFrom(NetPlan netPlan)
```
    Assigns the information from the input NetPlan.
    
    Important: A shadow copy is made, an the object netPlan used as parameter cannot be longer used, since all their nodes, links etc. are now assigned to the returned object. For having a deep copy of a net2plan object use copyFrom()
    
    Parameters:
    
    netPlan - Network plan to be assigned
    
    Since:
    
    0.3.0
  - checkCachesConsistency
```
public void checkCachesConsistency()
```
    For debug purposes: Checks the consistency of the internal cache (nodes, srgs, resources, layers, links, demands, multicast demands, multicast trees, routes). If any inconsistency is found an exception is thrown.
  - checkContiguousPath
```
public NetworkLayer checkContiguousPath(List<Link> links,
                                        NetworkLayer layer,
                                        Node originNode,
                                        Node destinationNode)
```
    Checks that the input sequence of links belong to the same layer and follow a contiguous path. Throws an exception if the path is not contiguous or the sequence of links is empty.
    
    Parameters:
    
    links - Sequence of links
    
    layer - Network layer
    
    originNode - Origin node
    
    destinationNode - Destination node
    
    Returns:
    
    The input layer
  - checkInThisNetPlanOptionalLayerParameter
```
public NetworkLayer checkInThisNetPlanOptionalLayerParameter(NetworkLayer... optionalLayer)
```
    Checks if the given layer is valid and belongs to this NetPlan design. Throws and exception if the input is invalid.
    
    Parameters:
    
    optionalLayer - Network layer (optional)
    
    Returns:
    
    The given layer (or the defaukt layer if no input was given)
  - checkMatrixDemandLinkCarriedTrafficFlowConservationConstraints
```
public DoubleMatrix1D checkMatrixDemandLinkCarriedTrafficFlowConservationConstraints(DoubleMatrix2D x_de,
                                                                                     boolean xdeValueAsFractionsRespectToDemandOfferedTraffic,
                                                                                     NetworkLayer... optionalLayerParameter)
```
    Checks the flow conservation constraints, and returns the traffic carried per demand.
    
    Parameters:
    
    x_de - Amount of traffic from demand d (i-th row) transmitted through link e (j-th column) in traffic units
    
    xdeValueAsFractionsRespectToDemandOfferedTraffic - If true, x_de values are measured as fractions [0,1] instead of traffic units
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    Carried traffic per demand (i-th position is the demand index and the value is the carried traffic)
  - checkMatrixDestinationLinkCarriedTrafficFlowConservationConstraints
```
public DoubleMatrix2D checkMatrixDestinationLinkCarriedTrafficFlowConservationConstraints(DoubleMatrix2D x_te,
                                                                                          NetworkLayer... optionalLayerParameter)
```
    Checks the flow conservation constraints, and returns the traffic carried per input output node pair.
    
    Parameters:
    
    x_te - Amount of traffic targeted to node t (i-th row) transmitted through link e (j-th column) in traffi units
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    Carried traffic per input (i-th row) output (j-th column) node pair
  - computeMulticastCandidatePathList
```
public SortedMap<MulticastDemand,List<SortedSet<Link>>> computeMulticastCandidatePathList(DoubleMatrix1D costs,
                                                                                          String solverName,
                                                                                          String solverLibraryName,
                                                                                          double maxSolverTimeInSecondsPerTree,
                                                                                          String... candidateTreeListParamValuePairs)
```
    The same as computeMulticastCandidatePathList for the default layer
    
    Parameters:
    
    costs - see computeMulticastCandidatePathList
    
    solverName - see computeMulticastCandidatePathList
    
    solverLibraryName - see computeMulticastCandidatePathList
    
    maxSolverTimeInSecondsPerTree - see computeMulticastCandidatePathList
    
    candidateTreeListParamValuePairs - see computeMulticastCandidatePathList
    
    Returns:
    
    see computeMulticastCandidatePathList
  - computeMulticastCandidatePathList
```
public SortedMap<MulticastDemand,List<SortedSet<Link>>> computeMulticastCandidatePathList(NetworkLayer layer,
                                                                                          DoubleMatrix1D linkCosts,
                                                                                          String solverName,
                                                                                          String solverLibraryName,
                                                                                          double maxSolverTimeInSecondsPerTree,
                                                                                          String... candidateTreeListParamValuePairs)
```
    Adds multicast trees specified by those trees that satisfy the options described below. Existing multicast trees will not be removed.
    
    The candidate tree list elaborated contains a set of multicast trees (each one is a set of links) computed for each multicast demand in the network. To compute it, a ILP formulation is solved for each new multicast tree. In general, for every multicast demand k trees are computed ranked according to its cost (weight) according to some link weights.
    
    The computation of paths can be configured via "parameter=value" options. There are several options to configure, which can be combined:
    - K: Number of desired multicast trees per demand (default: 3). If K'<K different trees are found for the multicast demand, then only K' are included in the candidate list
    - maxCopyCapability: the maximum number of copies of an input traffic a node can make. Then, a node can have at most this number of ouput links carrying traffic of a multicast tree (default: Double.MAX_VALUE)
    - maxE2ELengthInKm: Maximum path length measured in kilometers allowed for any tree, from the origin node, to any destination node (default: Double.MAX_VALUE)
    - maxE2ENumHops: Maximum number of hops allowed for any tree, from the origin node, to any destination node (default: Integer.MAX_VALUE)
    - maxE2EPropDelayInMs: Maximum propagation delay in miliseconds allowed in a path, for any tree, from the origin node, to any destination node (default: Double.MAX_VALUE)
    - maxTreeCost: Maximum tree weight allowed, summing the weights of the links (default: Double.MAX_VALUE)
    - maxTreeCostFactorRespectToMinimumCostTree: Trees with higher weight (cost) than the cost of the minimum cost tree, multiplied by this factor, are not returned (default: Double.MAX_VALUE)
    - maxTreeCostRespectToMinimumCostTree: Trees with higher weight (cost) than the cost of the minimum cost tree, plus this factor, are not returned (default: Double.MAX_VALUE). While the previous one is a multiplicative factor, this one is an additive factor
    Parameters:
    
    layer - the layer for which the candidate multicast tree list is computed
    
    linkCosts - Link weight vector for the shortest path algorithm. If null, a vector of ones is assumed
    
    solverName - the name of the solver to call for the internal formulation of the algorithm
    
    solverLibraryName - the solver library name
    
    maxSolverTimeInSecondsPerTree - the maximum time the solver is allowed for each of the internal formulations (one for each new tree). The best solution found so far is returned. If non-positive, no time limit is set
    
    candidateTreeListParamValuePairs - Parameters to be passed to the class to tune its operation. An even number of String is to be passed. For each String pair, first String must be the name of the parameter, second a String with its value. If no name-value pairs are set, default values are used
    
    Returns:
    
    SortedMap with a list of all the computed trees (a tree is a set of links) per multicast demands
  - computeMulticastTreeCostVector
```
public DoubleMatrix1D computeMulticastTreeCostVector(double[] costs,
                                                     NetworkLayer... optionalLayerParameter)
```
    Returns an array with the cost of each multicast tree in the layer. The cost of a multicast tree is given by the sum of the costs in its links, given by the provided cost vector. If the cost vector provided is null, all links have cost one.
    
    Parameters:
    
    costs - Costs array
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The cost of each multicast tree
    
    See Also:
    
    MulticastTree
  - computeRouteCostVector
```
public DoubleMatrix1D computeRouteCostVector(double[] costs,
                                             NetworkLayer... optionalLayerParameter)
```
    Returns an array with the cost of each route in the layer. The cost of a route is given by the sum of the costs of its links, given by the provided cost vector. If the cost vector provided is null, all links have cost one.
    
    Parameters:
    
    costs - Costs array
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The cost of each route in the network
    
    See Also:
    
    Route
  - computeUnicastCandidate11PathList
```
public static SortedMap<Pair<Node,Node>,List<Pair<List<Link>,List<Link>>>> computeUnicastCandidate11PathList(Map<Pair<Node,Node>,List<List<Link>>> cpl,
                                                                                                             int disjointType)
```
    Computes a list of disjoint path pairs for each node pair, using the paths in the input candidate path list given.
    
    Parameters:
    
    cpl - Candidate path list per demand
    
    disjointType - Type of disjointness: 0 for SRG-disjoint, 1 for link and node disjoint, other value means link disjoint
    
    Returns:
    
    List of disjoint path pairs for each demand
  - computeUnicastCandidate11ServiceChainList
```
public static SortedMap<Demand,List<Pair<List<NetworkElement>,List<NetworkElement>>>> computeUnicastCandidate11ServiceChainList(SortedMap<Demand,List<List<NetworkElement>>> cpl,
                                                                                                                                int disjointType)
```
    Computes a list of disjoint service chain pairs for each demand (service chain requests), using the service chain paths in the input candidate path list given.
    
    Parameters:
    
    cpl - Candidate path list per demand
    
    disjointType - Type of disjointness: 0 for SRG-disjoint, 1 for link and node disjoint, other value means link disjoint
    
    Returns:
    
    List of disjoint path pairs for each demand
  - computeUnicastCandidatePathList
```
public SortedMap<Pair<Node,Node>,List<List<Link>>> computeUnicastCandidatePathList(DoubleMatrix1D linkCosts,
                                                                                   int K,
                                                                                   double maxLengthInKm,
                                                                                   int maxNumHops,
                                                                                   double maxPropDelayInMs,
                                                                                   double maxRouteCost,
                                                                                   double maxRouteCostFactorRespectToShortestPath,
                                                                                   double maxRouteCostRespectToShortestPath,
                                                                                   SortedSet<Pair<Node,Node>> nodePairs,
                                                                                   NetworkLayer... optionalLayerParameter)
```
    Computes for all the node pairs, a candidate path list in the given layer, composed of the k shortest paths according with the options indicated below.
    
    Parameters:
    
    linkCosts - the cost of each link (if null, all links have cost one), all numbers must be strictly positive
    
    K - Desired nummber of paths (a lower number of paths may be returned if there are less than K loop-less paths admissible)
    
    maxLengthInKm - Maximum length of the path. If non-positive, no maximum limit is assumed
    
    maxNumHops - Maximum number of hops. If non-positive, no maximum limit is assumed
    
    maxPropDelayInMs - Maximum propagation delay of the path. If non-positive, no maximum limit is assumed
    
    maxRouteCost - Maximum route cost. If non-positive, no maximum limit is assumed
    
    maxRouteCostFactorRespectToShortestPath - Maximum route cost factor respect to the shortest path. If non-positive, no maximum limit is assumed
    
    maxRouteCostRespectToShortestPath - Maximum route cost respect to the shortest path. If non-positive, no maximum limit is assumed
    
    nodePairs - if this parameter is not null, the paths are computed only for this node pairs
    
    optionalLayerParameter - the layer (optional)
    
    Returns:
    
    SortedMap with all the computed paths (values) per node pairs (keys)
  - computeUnicastCandidateServiceChainList
```
public SortedMap<Demand,List<List<NetworkElement>>> computeUnicastCandidateServiceChainList(DoubleMatrix1D linkCosts,
                                                                                            DoubleMatrix1D resourceCosts,
                                                                                            int K,
                                                                                            double maxCostServiceChain,
                                                                                            double maxLengthInKmPerSubpath,
                                                                                            int maxNumHopsPerSubpath,
                                                                                            double maxPropDelayInMsPerSubpath,
                                                                                            NetworkLayer... optionalLayerParameter)
```
    Computes for each demand (service chain request) up to k minimum cost service chain paths (sequence and links and resources), according to the link and resources cost information provided, as well as other constraints defined in the input parameters. The algorithm calls the function getKMinimumCostServiceChains in GraphUtils, for each demand. Some of the constraints limit the vaild subpaths, where a subpath means the sequence of links between two consecutive resources, or from origin/end node to to/from its next/previous visited resource.
    
    Parameters:
    
    linkCosts - the cost of each link (if null, all links have cost one), all numbers must be strictly positive
    
    resourceCosts - a vector with the cost of each resource (if null, all resources have cost zero). All costs must be nonnegative. If a resource has a cost of Double.MAX_VALUE, it is as if it did not existed (cannot be traversed)
    
    K - The maximum number of service chains to return (less than K may be returned if there are no different paths).
    
    maxCostServiceChain - Service chains with a cost higher than this are not enumerated
    
    maxLengthInKmPerSubpath - The maximum length in km in each subpath. Service chains not satisfying this are not enumerated
    
    maxNumHopsPerSubpath - The maximum number of traversed links in each subpath. Service chains not satisfying this are not enumerated
    
    maxPropDelayInMsPerSubpath - The propagation delay summing the links in each subpath. Service chains not satisfying this are not enumerated
    
    optionalLayerParameter - the optional layer parameter
    
    Returns:
    
    SortedMap with all the computed service chain paths (values) per demands (keys)
  - copy
```
public NetPlan copy()
```
    Returns a deep copy of the current design.
    
    Returns:
    
    Deep copy of the current design
    
    Since:
    
    0.2.0
  - copyFrom
```
public void copyFrom(NetPlan originNetPlan)
```
    Removes all information from the current NetPlan and copy the information from the input NetPlan.
    
    Parameters:
    
    originNetPlan - Network plan to be copied from
  - getAllLinksPerQosOccupationAndQosViolationMap
```
public SortedMap<Link,SortedMap<String,Pair<Double,Double>>> getAllLinksPerQosOccupationAndQosViolationMap(NetworkLayer... optionalLayerParameter)
```
    For each link in the given layer, returns a map, with key the QoS types traversing it, and two associated values: (i) the total traffic occupied of such Qos type, (ii) the amount out of that traffic that is violating the QoS
    
    Parameters:
    
    optionalLayerParameter - see above
    
    Returns:
    
    see above
  - getAllPlotNodeLayoutsDefined
```
public SortedSet<String> getAllPlotNodeLayoutsDefined()
```
    Returns all the names (identifiers) of the current node layout
    
    Returns:
    
    see above
  - getAttributes
```
public static SortedMap<NetworkElement,String> getAttributes(Collection<? extends NetworkElement> collection,
                                                             String attribute)
```
    Returns the values of a given attribute for all the provided network elements.
    
    Parameters:
    
    collection - Collection of network elements
    
    attribute - Attribute name
    
    Returns:
    
    SortedMap with the value of each attribute per network element (value may be null if not defined
    
    See Also:
    
    NetworkElement
  - getAttributeValues
```
public static DoubleMatrix1D getAttributeValues(Collection<? extends NetworkElement> collection,
                                                String attributeName,
                                                double defaultValue)
```
    Returns the values of a given attribute for all the provided network elements, as a DoubleMatrix1D vector.
    
    Parameters:
    
    collection - Collection of network elements
    
    attributeName - Attribute name
    
    defaultValue - If an element has value for the attribute, or it is not a double (it fails in the Double.parseDouble conversion), then this value is set
    
    Returns:
    
    array with one element per NetworkElement, in the same order as the input Collection.
    
    See Also:
    
    NetworkElement
  - getDemand
```
public Demand getDemand(int index,
                        NetworkLayer... optionalLayerParameter)
```
    Returns the demand with the given index.
    
    Parameters:
    
    index - Demand index
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The demand with the given index (or null if nonexistent, index lower than 0 or greater than the number of elements minus one)
    
    See Also:
    
    Demand
  - getDemandFromId
```
public Demand getDemandFromId(long uid)
```
    Returns the demand with the given unique identifier.
    
    Parameters:
    
    uid - Demand unique id
    
    Returns:
    
    The demand with the given unique id (or null if nonexistent)
    
    See Also:
    
    Demand
  - getDemandIds
```
public ArrayList<Long> getDemandIds(NetworkLayer... optionalLayerParameter)
```
    Returns the array of demand unique ids for the given layer (i-th position, corresponds to index i). If no layer is provided, the default layer is used.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    ArrayList of demand ids for the given layer (or the default layer if no input was provided)
    
    See Also:
    
    Demand
  - getDemands
```
public List<Demand> getDemands(NetworkLayer... optionalLayerParameter)
```
    Returns the array of demands for the given layer (i-th position, corresponds to index i). If no layer is provided, the default layer is used.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    List of demands for the given layer (or the default layer if no input was provided)
    
    See Also:
    
    Demand
  - getDemandsBlocked
```
public List<Demand> getDemandsBlocked(NetworkLayer... optionalLayerParameter)
```
    Returns the demands that have blocked traffic in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    List of demands with blocked traffic
    
    See Also:
    
    Demand
  - getDemandsCoupled
```
public SortedSet<Demand> getDemandsCoupled(NetworkLayer... optionalLayerParameter)
```
    Returns the set of unicast demands that are coupled.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    SortedSet of unicast demands that have blocked traffic for the given layer (or the defaukt layer if no input was provided)
  - getDemandsHopByHopRouted
```
public List<Demand> getDemandsHopByHopRouted(NetworkLayer... optionalLayerParameter)
```
    Returns the array of demands in the given layer that are hop-by-hop routed, ordered by its index.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    see above
  - getDemandsSourceRouted
```
public List<Demand> getDemandsSourceRouted(NetworkLayer... optionalLayerParameter)
```
    Returns the array of demands in the given layer that are source routed, ordered by its index.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    see above
  - getDemandTrafficUnitsName
```
public String getDemandTrafficUnitsName(NetworkLayer... optionalLayerParameter)
```
    Returns the name of the traffic units of the demands of the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    String with the traffic units name of the demands
  - getForwardingRuleCarriedTraffic
```
public double getForwardingRuleCarriedTraffic(Demand demand,
                                              Link link)
```
    Returns the traffic that is carried using a forwarding rule, in the given layer. If no layer is provided, the default layer is assumed.
    
    Important: Routing type must be HOP_BY_HOP_ROUTING.
    
    Parameters:
    
    demand - Outgoing demand
    
    link - Link
    
    Returns:
    
    Carried traffic by the given link from the given demand using a forwarding rule
  - getForwardingRules
```
public SortedMap<Pair<Demand,Link>,Double> getForwardingRules(NetworkLayer... optionalLayerParameter)
```
    Returns the forwarding rules for the given layer. If no layer is provided, the default layer is assumed.
    
    Important: Routing type must be HOP_BY_HOP_ROUTING.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The forwarding rules as a map of splitting factor (value) per demand and link (key)
    
    See Also:
    
    Pair
  - getForwardingRuleSplittingFactor
```
public double getForwardingRuleSplittingFactor(Demand demand,
                                               Link link)
```
    Returns the splitting factor of the forwarding rule of the given demand and link, which must be of the same layer.
    
    Parameters:
    
    demand - Outgoing demand
    
    link - Link
    
    Returns:
    
    The splitting factor
  - getGlobalPlanningDomainNodes
```
public SortedSet<Node> getGlobalPlanningDomainNodes(String planningDomain)
```
    Returns the network elements associated to the given planning domain, or null if the planning domain was not defined
    
    Parameters:
    
    planningDomain - the planning domain
    
    Returns:
    
    see above
  - getGlobalPlanningDomains
```
public SortedSet<String> getGlobalPlanningDomains()
```
    Returns the set of defined planning domains in this network design
    
    Returns:
    
    see above
  - getIds
```
public static Collection<Long> getIds(Collection<? extends NetworkElement> collection)
```
    Returns the unique ids of the provided network elements.
    
    Parameters:
    
    collection - Network elements
    
    Returns:
    
    Unique ids of the provided network elements. If the input Collection is a SortedSet, the returned collection is a TreeSet. If the input Collection is a List, an ArrayList is returned}.
  - getIndexes
```
public static Collection<Integer> getIndexes(Collection<? extends NetworkElement> collection)
```
    Returns the indexes of the provided network elements.
    
    Parameters:
    
    collection - Network elements
    
    Returns:
    
    Indexes of the provided network elements. If the input Collection is a SortedSet, the returned collection is a TreeSet. If the input Collection is a List, an ArrayList is returned}.
  - getLink
```
public Link getLink(int index,
                    NetworkLayer... optionalLayerParameter)
```
    Returns the link with the given index in the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    index - Link index
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    Link with the given index or null if it does not exist, index islower than 0, or greater than the number of links minus one
  - getLinkCapacityUnitsName
```
public String getLinkCapacityUnitsName(NetworkLayer... optionalLayerParameter)
```
    Returns the name of the capacity units of the links of the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The name of capacity units
  - getLinkFromId
```
public Link getLinkFromId(long uid)
```
    Returns the link with the given unique identifier.
    
    Parameters:
    
    uid - Link unique id
    
    Returns:
    
    Link with the given id, or null if it does not exist
  - getLinkIds
```
public ArrayList<Long> getLinkIds(NetworkLayer... optionalLayerParameter)
```
    Returns the array of link ids for the given layer (i-th position, corresponds to index i). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional
    
    Returns:
    
    Array of link ids
  - getLinks
```
public List<Link> getLinks(NetworkLayer... optionalLayerParameter)
```
    Return a list of all the links in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    All the links for the given (or default) layer
  - getLinksAreBottleneck
```
public SortedSet<Link> getLinksAreBottleneck(NetworkLayer... optionalLayerParameter)
```
    Returns the set of links that are a bottleneck, i.e the fraction of occupied capacity respect to the total is highest. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The SortedSet of bottleneck links
  - getLinksCoupledToMulticastDemands
```
public SortedSet<Link> getLinksCoupledToMulticastDemands(NetworkLayer... optionalLayerParameter)
```
    Returns the set of links that are coupled to a multicast demand in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The SortedSet of links coupled to a multicast demand
    
    See Also:
    
    MulticastDemand
  - getLinksCoupledToUnicastDemands
```
public SortedSet<Link> getLinksCoupledToUnicastDemands(NetworkLayer... optionalLayerParameter)
```
    Returns the set of links that are couple to a unicast demand in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The SortedSet of links coupled to a unicast demand
    
    See Also:
    
    Demand
  - getLinksDown
```
public SortedSet<Link> getLinksDown(NetworkLayer... optionalLayerParameter)
```
    Returns the set of links that are down in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The SortedSet of links that are down
  - getLinksDownAllLayers
```
public SortedSet<Link> getLinksDownAllLayers()
```
    Returns the set of links that are down in all layers.
    
    Returns:
    
    The SortedSet of links down
  - getLinksOversubscribed
```
public SortedSet<Link> getLinksOversubscribed(NetworkLayer... optionalLayerParameter)
```
    Returns the set of links oversuscribed: the total occupied capacity exceeds the link capacity. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The SortedSet of oversubscribed links
  - getLinksUp
```
public SortedSet<Link> getLinksUp(NetworkLayer... optionalLayerParameter)
```
    Returns the set of links that are up in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer )optional)
    
    Returns:
    
    The SortedSet of links that are up
  - getLinksUpAllLayers
```
public SortedSet<Link> getLinksUpAllLayers()
```
    Returns the set of links that are up in all layers.
    
    Returns:
    
    The SortedSet of links that are up
  - getLinksWithZeroCapacity
```
public SortedSet<Link> getLinksWithZeroCapacity(NetworkLayer... optionalLayerParameter)
```
    Returns the set of links that have zero capacity in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The SortedSet of links with zero capacity
  - getMatrixDemand2LinkAssignment
```
public DoubleMatrix2D getMatrixDemand2LinkAssignment(NetworkLayer... optionalLayerParameter)
```
    Returns the demand-link incidence matrix (a DxE matrix in which an element δ_de is equal to the number of times which traffic routes carrying traffic from demand d traverse link e). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The demand-link incidence matrix
  - getMatrixDemand2LinkTrafficCarried
```
public DoubleMatrix2D getMatrixDemand2LinkTrafficCarried(SortedSet<Demand> demandsOfInterest,
                                                         NetworkLayer... optionalLayerParameter)
```
    Returns the demand-link incidence matrix (DxE in which an element δ_de is equal to the amount of traffic of each demand carried in each link). Rows and columns are in increasing order of demand and link identifiers, respectively. If no layer is provided, the default layer is assumed
    
    Important: Routing type must be HOP_BY_HOP_ROUTING.
    
    Parameters:
    
    demandsOfInterest - List of demands
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    Splitting ratio matrix
  - getMatrixDemand2ResourceAssignment
```
public DoubleMatrix2D getMatrixDemand2ResourceAssignment(NetworkLayer... optionalLayerParameter)
```
    Returns the demand-resource incidence matrix, with as many rows as demands of the given layer, and a many colmns as resources, coordinate (d,r) equals the number of times that traffic routes of the demand d, traverse resource r. Demands that are hop-by-hop routed have zeros If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The demand-link incidence matrix
  - getMatrixDemand2ResourceOccupiedCapacity
```
public DoubleMatrix2D getMatrixDemand2ResourceOccupiedCapacity(NetworkLayer... optionalLayerParameter)
```
    Returns the demand-resource matrix, with as many rows as demands of the given layer, and as many columns as resources, coordinate (d,r) is the resource capacity that demand d currently occupies in resource r (recall that failed routes do not occupy capacity in the traversed resources). If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The matrix
  - getMatrixDemand2RouteAssignment
```
public DoubleMatrix2D getMatrixDemand2RouteAssignment(NetworkLayer... optionalLayerParameter)
```
    Returns the demand-route incidence matrix (a DxR matrix in which an element δ_dr is equal to 1 if traffic route r is able to carry traffic from demand d). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The demand-route incidence matrix
  - getMatrixDemandBasedForwardingRules
```
public DoubleMatrix2D getMatrixDemandBasedForwardingRules(NetworkLayer... optionalLayerParameter)
```
    Returns the splitting ratio matrix (fractions of traffic entering a node from demand 'd', leaving that node through link 'e'). Rows and columns are in increasing order of demand and link identifiers, respectively. If no layer is provided, the default layer is assumed. For the demands that are SOURCE ROUTING, the routes are internally converted into forwarding rules, using the carried traffic of the routes (the link occupation information is not used)
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    Splitting ratio matrix
  - getMatrixDestination2LinkTrafficCarried
```
public DoubleMatrix2D getMatrixDestination2LinkTrafficCarried(NetworkLayer... optionalLayerParameter)
```
  - getMatrixDestinationBasedForwardingRules
```
public DoubleMatrix2D getMatrixDestinationBasedForwardingRules(NetworkLayer... optionalLayer)
```
    A destination-based routing in the form of fractions f_te (fraction of the traffic targeted to node t that arrives (or is generated in) node a(e) (the initial node of link e), that is forwarded through link e). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayer - Network layer (optional)
    
    Returns:
    
    A destination-based routing from a given network design
  - getMatrixLink2LinkBidirectionalityMatrix
```
public DoubleMatrix2D getMatrixLink2LinkBidirectionalityMatrix(NetworkLayer... optionalLayerParameter)
```
    Returns the link-link bidirectionality matrix (a ExE matrix where the element δ_ee' equals 1 when each position e and e' represent a bidirectional link at the given layer. If no layer is provided, default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The link-link bidirectionality matrix
  - getMatrixLink2MulticastTreeAssignment
```
public DoubleMatrix2D getMatrixLink2MulticastTreeAssignment(NetworkLayer... optionalLayerParameter)
```
    Returns the link-multicast incidence matrix (an ExT matrix in which an element δ_et is equal to the number of times a multicast tree t traverse link e. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The link-multicast tree incidence matrix
  - getMatrixLink2RouteAssignment
```
public DoubleMatrix2D getMatrixLink2RouteAssignment(NetworkLayer... optionalLayerParameter)
```
    Returns the link-route incidence matrix (an ExR matrix in which an element δ_ep is equal to the number of times which traffic route r traverses link e). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The link-route incidene matrix
  - getMatrixLink2RouteFirstBackupRouteAssignment
```
public DoubleMatrix2D getMatrixLink2RouteFirstBackupRouteAssignment(NetworkLayer... optionalLayerParameter)
```
    Returns a matrix with as many rows as links and as many columns as routes in the given layer, the position (e,r) contains the number of times that the first backup path of route r traveres link e
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The matrix
  - getMatrixLink2SRGAssignment
```
public DoubleMatrix2D getMatrixLink2SRGAssignment(NetworkLayer... optionalLayerParameter)
```
    Returns the link-srg assignment matrix (an ExS matrix in which an element δ_es equals 1 if link e fails when SRG s is affected. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The link-srg incidence matrix
  - getMatrixMulticastDemand2LinkAssignment
```
public DoubleMatrix2D getMatrixMulticastDemand2LinkAssignment(NetworkLayer... optionalLayerParameter)
```
    Returns the multicast demand-link incidence matrix (a DxE matrix in which an element δ_de is equal to the number of times which multicast trees carrying traffic from demand d traverse link e). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The multicast demand-link incidence matrix
  - getMatrixMulticastDemand2LinkTrafficCarried
```
public DoubleMatrix2D getMatrixMulticastDemand2LinkTrafficCarried(NetworkLayer... optionalLayerParameter)
```
    Returns the multicast demand-link incidence matrix (DxE in which an element δ_de is equal to the amount of traffic of each multicast demand carried in each link). Rows and columns are in increasing order of demand and link identifiers, respectively. If no layer is provided, the default layer is assumed
    
    Important: Routing type must be HOP_BY_HOP_ROUTING.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    Splitting ratio matrix
  - getMatrixMulticastDemand2MulticastTreeAssignment
```
public DoubleMatrix2D getMatrixMulticastDemand2MulticastTreeAssignment(NetworkLayer... optionalLayerParameter)
```
    Returns the multicast demand-multicast tree incidence matrix (a DxT matrix in which an element δ_dt is equal to 1 if multicast tree t is able to carry traffic from multicast demand d). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The multicast demand-multicast tree incidence matrix
  - getMatrixMulticastTree2SRGAffecting
```
public DoubleMatrix2D getMatrixMulticastTree2SRGAffecting(NetworkLayer... optionalLayerParameter)
```
    Returns the multicast tree-srg incidence matrix (an TxS matrix in which an element δ_ts equals 1 when multicast tree t fails when SRG s is affected. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The multicast tree-srg incidence matrix
  - getMatrixNode2NodeEuclideanDistance
```
public DoubleMatrix2D getMatrixNode2NodeEuclideanDistance()
```
    Returns the NxN Euclidean distance matrix (derived from node coordinates), where N is the number of nodes within the network.
    
    Returns:
    
    The Euclidean distance matrix
  - getMatrixNode2NodeHaversineDistanceInKm
```
public DoubleMatrix2D getMatrixNode2NodeHaversineDistanceInKm()
```
    Returns the NxN Haversine distance matrix (derived from node coordinates, where 'xCoord' is equal to longitude and 'yCoord' is equal to latitude), where N is the number of nodes within the network.
    
    Returns:
    
    Haversine distance matrix
    
    See Also:
    
    Calculate distance, bearing and more between Latitude/Longitude points
  - getMatrixNode2NodeOfferedTraffic
```
public DoubleMatrix2D getMatrixNode2NodeOfferedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the traffic matrix, where rows and columns represent the ingress node and the egress node, respectively, in increasing order of identifier. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The traffic matrix
  - getMatrixNodeDemandAdjacency
```
public DoubleMatrix2D getMatrixNodeDemandAdjacency(NetworkLayer... optionalLayerParameter)
```
    Returns a NxN matrix where each position accounts from the humber of demands that node i (row) as ingress node and j (column) as egress node. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    Adjacency matrix
  - getMatrixNodeDemandIncidence
```
public DoubleMatrix2D getMatrixNodeDemandIncidence(NetworkLayer... optionalLayerParameter)
```
    Returns the node-demand incidence matrix (a NxD in which an element δ_nd equals 1 if n is the ingress node of d, -1 if n is the egress node of d and 0 otherwise). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer
    
    Returns:
    
    The node-demand incidence matrix
  - getMatrixNodeDemandIncomingIncidence
```
public DoubleMatrix2D getMatrixNodeDemandIncomingIncidence(NetworkLayer... optionalLayerParameter)
```
    Returns the node-demand incoming incidence matrix (a NxD matrix in which element δ_nd equals 1 if demand d is terminated in node n and 0 otherwise. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The node-demand incoming incidence matrix
  - getMatrixNodeDemandOutgoingIncidence
```
public DoubleMatrix2D getMatrixNodeDemandOutgoingIncidence(NetworkLayer... optionalLayerParameter)
```
    Returns the node-demand outgoing incidence matrix (a NxD matrix in which element δ_nd equals 1 if demand d is initiated in node n and 0 otherwise. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The node-demand outgoing incidence matrix
  - getMatrixNodeLinkAdjacency
```
public DoubleMatrix2D getMatrixNodeLinkAdjacency(NetworkLayer... optionalLayerParameter)
```
    Returns the node-link adjacency matrix (a NxN matrix in which element δ_ij is equals to the number of links from node i to node j. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The node-link adjacency matrix
  - getMatrixNodeLinkIncidence
```
public DoubleMatrix2D getMatrixNodeLinkIncidence(NetworkLayer... optionalLayerParameter)
```
    Returns the node-link incidence matrix (a NxE matrix in which element δ_ne equals 1 if link e is initiated in node n, -1 if link e ends in node n, and 0 otherwise. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The node-link incidence matrix
  - getMatrixNodeLinkIncomingIncidence
```
public DoubleMatrix2D getMatrixNodeLinkIncomingIncidence(NetworkLayer... optionalLayerParameter)
```
    Returns the node-link incoming incidence matrix (a NxE matrix in which element δ_ne equals 1 if link e is terminated in node n, and 0 otherwise. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The node-link incoming incidence matrix
  - getMatrixNodeLinkOutgoingIncidence
```
public DoubleMatrix2D getMatrixNodeLinkOutgoingIncidence(NetworkLayer... optionalLayerParameter)
```
    Returns the node-link outgoing incidence matrix (a NxE matrix in which element δ_ne equals 1 if link e is initiated in node n, and 0 otherwise. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The node-link outgoing incidence matrix
  - getMatrixNodeMulticastDemandAdjacency
```
public DoubleMatrix2D getMatrixNodeMulticastDemandAdjacency(NetworkLayer... optionalLayerParameter)
```
    Returns a NxN matrix where each position accounts from the humber of multicast demands that node i (row) as ingress node and j (column) as an egress node. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    Adjacency matrix
  - getMatrixNodeMulticastDemandIncidence
```
public DoubleMatrix2D getMatrixNodeMulticastDemandIncidence(NetworkLayer... optionalLayerParameter)
```
    Returns the node-multicast demand incidence matrix (a NxD in which an element δ_nd equals 1 if n is the ingress node of d, -1 if n is an egress node of d and 0 otherwise). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer
    
    Returns:
    
    The node-multicast demand incidence matrix
  - getMatrixNodeMulticastDemandIncomingIncidence
```
public DoubleMatrix2D getMatrixNodeMulticastDemandIncomingIncidence(NetworkLayer... optionalLayerParameter)
```
    Returns the node-multicast demand incoming incidence matrix (a NxD matrix in which element δ_nd equals 1 if multicast demand d is terminated in node n and 0 otherwise. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The node-multicast demand incoming incidence matrix
  - getMatrixNodeMulticastDemandOutgoingIncidence
```
public DoubleMatrix2D getMatrixNodeMulticastDemandOutgoingIncidence(NetworkLayer... optionalLayerParameter)
```
    Returns the node-multicast demand outgoing incidence matrix (a NxD matrix in which element δ_nd equals 1 if demand d is initiated in node n and 0 otherwise. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The node-multicast demand outgoing incidence matrix
  - getMatrixResource2NodeAssignment
```
public DoubleMatrix2D getMatrixResource2NodeAssignment()
```
    Returns a matrix with as many rows resources, and columns as nodes. Coordinate (res,n) is 1 if resource res is hosted in node n
    
    Returns:
    
    The matrix
  - getMatrixResource2ResourceType
```
public DoubleMatrix2D getMatrixResource2ResourceType(String type)
```
    Returns a matrix with as many rows resources as resources of the given type (ordered in an arbitrary form), and as many columns as resources in the network. It is constructed by taking the diagonal matrix, and keeping only the rows associated to resources of the given type. When left multiplied to a matrix with as many rows as resources, it keeps the rows associated to the resources of the given type, removing the rest.
    
    Parameters:
    
    type - the resource type
    
    Returns:
    
    The matrix
  - getMatrixResource2ResourceUpperToBaseAssignment
```
public DoubleMatrix2D getMatrixResource2ResourceUpperToBaseAssignment()
```
    Returns a matrix with as many rows and columns as resources. Coordinate (r1,r2) is 1 if r1 is an upper resource respect to r2, even if currently 0 capacity units are occupied in base resource r2 because of r1
    
    Returns:
    
    The matrix
  - getMatrixResource2ResourceUpperToBaseOccupation
```
public DoubleMatrix2D getMatrixResource2ResourceUpperToBaseOccupation()
```
    Returns a matrix with as many rows and columns as resources, coordinate (r1,r2) contains the capacity that resource r1 currently occupies in r2. If r2 is not a base resource of r1, coordinate is zero
    
    Returns:
    
    The matrix
  - getMatrixResource2RouteAssignment
```
public DoubleMatrix2D getMatrixResource2RouteAssignment(NetworkLayer... optionalLayerParameter)
```
    Returns a matrix with as many rows resources, and columns as routes in the given layer, coordinate (res,rou) contains the number times that route rou traverses resource res. If no layer is provided, default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - the layer (optional)
    
    Returns:
    
    The matrix
  - getMatrixResource2RouteAssignment
```
public Pair<List<Resource>,DoubleMatrix2D> getMatrixResource2RouteAssignment(String type,
                                                                             NetworkLayer... optionalLayerParameter)
```
    Returns a matrix with as many rows resources, and columns as routes in the given layer, coordinate (res,rou) contains the number times that route rou traverses resource res. If no layer is provided, default layer is assumed
    
    Parameters:
    
    type - The resource type
    
    optionalLayerParameter - the layer (optional)
    
    Returns:
    
    The matrix
  - getMatrixResource2RouteOccupation
```
public DoubleMatrix2D getMatrixResource2RouteOccupation(NetworkLayer... optionalLayerParameter)
```
    Returns a matrix with as many rows resources, and columns as routes in the given layer, and coordinate (res,rou) contains the capacity occupied by route rou in resource res (note that if a route is down, its occupied capacity in a resource becomes zero). If no layer is provided, default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - the layer (optional)
    
    Returns:
    
    The matrix
  - getMatrixResource2SRGAssignment
```
public DoubleMatrix2D getMatrixResource2SRGAssignment()
```
    Returns a matrix with as many rows resources, and columns as SRGs. Coordinate (res,srg) is 1 if resource res fails when srg fails
    
    Returns:
    
    The matrix
  - getMatrixRoute2SRGAffecting
```
public DoubleMatrix2D getMatrixRoute2SRGAffecting(NetworkLayer... optionalLayerParameter)
```
    Returns the route-srg incidence matrix (an RxS matrix in which an element δ_rs equals 1 if route r fails when SRG s is affected. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The route-srg incidence matrix
  - getMatrixRouteFirstBackupRoute2SRGAffecting
```
public DoubleMatrix2D getMatrixRouteFirstBackupRoute2SRGAffecting(NetworkLayer... optionalLayerParameter)
```
    Returns a matrix with as many rows as routes of the given layer, and as many columns as SRGS. The position (r,s) is 1 if the first backup route defined for route r is affected by SRG s (fails if s fails), and 0 otherwise. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The matrix
  - getMulticastDemand
```
public MulticastDemand getMulticastDemand(int index,
                                          NetworkLayer... optionalLayerParameter)
```
    Returns the multicast demand with the given index in the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    index - Multicast demand index
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The multicast demand (null if it does not exist, or index is lower than 0, or greater the number of elements minus one).
  - getMulticastDemandFromId
```
public MulticastDemand getMulticastDemandFromId(long uid)
```
    Returns the multicast demand with the given unique identifier.
    
    Parameters:
    
    uid - Multicast demand unique id
    
    Returns:
    
    The multicast demand, or null if it does not exist
  - getMulticastDemandIds
```
public ArrayList<Long> getMulticastDemandIds(NetworkLayer... optionalLayerParameter)
```
    Returns the array of multicast demand ids for the given layer (i-th position, corresponds to index i). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The ArrayList of multicast demand unique ids
  - getMulticastDemands
```
public List<MulticastDemand> getMulticastDemands(NetworkLayer... optionalLayerParameter)
```
    Returns the list of multicast demands for the given layer (i-th position, corresponds to multicast demand with index i). If no layer is provided, the default layer is used
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The list of multicast demands
  - getMulticastDemandsBlocked
```
public List<MulticastDemand> getMulticastDemandsBlocked(NetworkLayer... optionalLayerParameter)
```
    Returns the multicast demands that have blocked traffic in the given layer. If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The multicast demands with blocked traffic
  - getMulticastTree
```
public MulticastTree getMulticastTree(int index,
                                      NetworkLayer... optionalLayerParameter)
```
    Returns the multicast tree with the given index in the given layer. if no layer is provided, default layer is assumed.
    
    Parameters:
    
    index - Multicast tree index
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The multicast tree (nullif it does not exist, index islower than 0, or greater than the number of elements minus one)
  - getMulticastTreeFromId
```
public MulticastTree getMulticastTreeFromId(long uid)
```
    Returns the multicast tree with the given unique identifier.
    
    Parameters:
    
    uid - Multicast tree unique id
    
    Returns:
    
    The multicast tree (null if it does not exist
  - getMulticastTreeIds
```
public ArrayList<Long> getMulticastTreeIds(NetworkLayer... optionalLayerParameter)
```
    Returns the array of multicast tree ids for the given layer (i-th position, corresponds to index i). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    the ArrayList of multicast trees unique ids
  - getMulticastTrees
```
public List<MulticastTree> getMulticastTrees(NetworkLayer... optionalLayerParameter)
```
    Returns the array of multicast trees for the given layer (i-th position, corresponds to index i). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The List of multicast trees
  - getMulticastTreesDown
```
public SortedSet<MulticastTree> getMulticastTreesDown(NetworkLayer... optionalLayerParameter)
```
    Returns the set of multicast trees that are down (i.e. that traverse a link or node that has failed).
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    the SortedSet of multicast trees that are down
  - getMulticastTreesTraversingZeroCapLinks
```
public SortedSet<MulticastTree> getMulticastTreesTraversingZeroCapLinks(NetworkLayer... optionalLayerParameter)
```
    Returns the set of multicast trees that are down (i.e. that traverse a link or node that has failed).
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    the SortedSet of multicast trees that are down
  - getNetworkElement
```
public NetworkElement getNetworkElement(long id)
```
    Return the network element with the given unique id.
    
    Parameters:
    
    id - Unique id
    
    Returns:
    
    The network element (null if it does not exist)
    
    See Also:
    
    NetworkElement
  - getNetworkElementByAttribute
```
public static NetworkElement getNetworkElementByAttribute(Collection<? extends NetworkElement> listOfElements,
                                                          String attribute,
                                                          String value)
```
    Returns the first network element among the ones passed as input parameters, that has the given key-value as attribute.
    
    Parameters:
    
    listOfElements - Lit of network elements
    
    attribute - Attribute name
    
    value - Attribute value
    
    Returns:
    
    First network element encountered with the given key-value (nullif no network element matches or the input null or empty
    
    See Also:
    
    NetworkElement
  - getNetworkElementNextId
```
public long getNetworkElementNextId()
```
    Returns the next identifier for a new network element (layer, node, link, demand...)
    
    Returns:
    
    Next identifier
  - getNetworkElementsByAttribute
```
public static Collection<? extends NetworkElement> getNetworkElementsByAttribute(Collection<? extends NetworkElement> listOfElements,
                                                                                 String attribute,
                                                                                 String value)
```
    Returns all the network elements among the ones passed as input parameters, that have the given key-value as attribute. Returns an empty list if no network element mathces this, the input list of elements is null or empty
    
    Parameters:
    
    listOfElements - List of network elements
    
    attribute - Attribute name
    
    value - Attribute value
    
    Returns:
    
    List of all network elements with the attribute key-value
  - getNetworkLayer
```
public NetworkLayer getNetworkLayer(int index)
```
    Returns the network layer with the given unique identifier.
    
    Parameters:
    
    index - Network layer index
    
    Returns:
    
    The network layer with the given index (null if it does not exist)
  - getNetworkLayer
```
public NetworkLayer getNetworkLayer(String name)
```
    Returns the network layer with the given name.
    
    Parameters:
    
    name - Network layer name
    
    Returns:
    
    The network layer with the given name (null if it does not exist)
  - getNetworkLayerDefault
```
public NetworkLayer getNetworkLayerDefault()
```
    Return the default network layer.
    
    Returns:
    
    The default network layer
  - getNetworkLayerFromId
```
public NetworkLayer getNetworkLayerFromId(long uid)
```
    Returns the network layer with the given unique identifier.
    
    Parameters:
    
    uid - Network layer unique id
    
    Returns:
    
    The network layer with the given id (null if it does not exist)
  - getNetworkLayerIds
```
public ArrayList<Long> getNetworkLayerIds()
```
    Returns the array of layer ids (i-th position, corresponds to index i).
    
    Returns:
    
    The ArraList of network layers
  - getNetworkLayerInTopologicalOrder
```
public List<NetworkLayer> getNetworkLayerInTopologicalOrder()
```
    Returns network layers in bottom-up order, that is, starting from the lower layers to the upper layers following coupling relationships. For layers at the same hierarchical level, no order is guaranteed.
    
    Returns:
    
    The SortedSet of network layers in topological order
    
    Since:
    
    0.3.0
  - getNetworkLayers
```
public List<NetworkLayer> getNetworkLayers()
```
    Returns the array of network layers (i-th position, corresponds to index i).
    
    Returns:
    
    The List of network layers
  - getNode
```
public Node getNode(int index)
```
    Returns the node with the given index.
    
    Parameters:
    
    index - Node index
    
    Returns:
    
    The node with the given index (null if it does not exist, index iss lesser than zero or greater than the number of elements minus one)
  - getNodeByName
```
public Node getNodeByName(String name)
```
    Returns the first node with the given name.
    
    Parameters:
    
    name - Node name
    
    Returns:
    
    The first node with the given name (null if it does not exist)
  - getNodeByNameAllNodes
```
public List<Node> getNodeByNameAllNodes(String name)
```
    Returns a list with all the nodes with the given name, or an empty list if none.
    
    Parameters:
    
    name - Node name
    
    Returns:
    
    see above
  - getNodeFromId
```
public Node getNodeFromId(long uid)
```
    Returns the node with the given unique identifier.
    
    Parameters:
    
    uid - Node unique id
    
    Returns:
    
    The node with the given id (null if it does not exist)
  - getNodeIds
```
public ArrayList<Long> getNodeIds()
```
    Returns the array of node ids (i-th position, corresponds to index i)
    
    Returns:
    
    The ArrayList of nodes
  - getNodePairDemands
```
public SortedSet<Demand> getNodePairDemands(Node originNode,
                                            Node destinationNode,
                                            boolean returnDemandsInBothDirections,
                                            NetworkLayer... optionalLayerParameter)
```
    Gets the set of demands at the given layer from the input nodes (if returnDemandsInBothDirections is true, also the reversed links are included). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    originNode - Origin node
    
    destinationNode - Destination node
    
    returnDemandsInBothDirections - Assume both directions
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    the SortedSet of demands that have the origin and destination for the given input
  - getNodePairEuclideanDistance
```
public double getNodePairEuclideanDistance(Node originNode,
                                           Node destinationNode)
```
    Gets the Euclidean distance for a node pair.
    
    Parameters:
    
    originNode - Origin node
    
    destinationNode - Destination node
    
    Returns:
    
    The Euclidean distance between a node pair
  - getNodePairHaversineDistanceInKm
```
public double getNodePairHaversineDistanceInKm(Node originNode,
                                               Node destinationNode)
```
    Gets the Haversine distance for a node pair.
    
    Parameters:
    
    originNode - Origin node
    
    destinationNode - Destination node
    
    Returns:
    
    The Harvesine distance between a node pair
    
    See Also:
    
    Calculate distance, bearing and more between Latitude/Longitude points
  - getNodePairLinks
```
public SortedSet<Link> getNodePairLinks(Node originNode,
                                        Node destinationNode,
                                        boolean returnLinksInBothDirections,
                                        NetworkLayer... optionalLayerParameter)
```
    Gets the set of links at the given layer from the given nodes (if returnLinksInBothDirections is true, also the reversed links are included). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    originNode - Origin node
    
    destinationNode - Destination node
    
    returnLinksInBothDirections - Include links in both direction
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    the SortedSet of links between a pair of nodes
  - getNodePairRoutes
```
public SortedSet<Route> getNodePairRoutes(Node originNode,
                                          Node destinationNode,
                                          boolean returnRoutesInBothDirections,
                                          NetworkLayer... optionalLayerParameter)
```
    Gets the set of routes at the given layer from the given nodes (if returnRoutesInBothDirections is true, also the reversed routes are included). If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    originNode - Origin node
    
    destinationNode - Destination node
    
    returnRoutesInBothDirections - Include routes in both directions
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The SortedSet of routes between a pair of nodes
  - getNodes
```
public List<Node> getNodes()
```
    Returns the array of nodes (i-th position, corresponds to index i).
    
    Returns:
    
    The List of nodes
  - getNodesDown
```
public SortedSet<Node> getNodesDown()
```
    Returns the set of nodes that are down (iteration order corresponds to ascending order of indexes).
    
    Returns:
    
    The SortedSet of nodes that are down
  - getNodesUp
```
public SortedSet<Node> getNodesUp()
```
    Returns the set of nodes that are up (iteration order correspond to ascending order of indexes).
    
    Returns:
    
    The SortedSet of nodes that are up
  - getNumberOfDemands
```
public int getNumberOfDemands(NetworkLayer... optionalLayerParameter)
```
    Returns the number of demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The number of demands
  - getNumberOfForwardingRules
```
public int getNumberOfForwardingRules(NetworkLayer... optionalLayerParameter)
```
    Returns the number of non-zero forwarding rules at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The number of non-zero forwarding rules
  - getNumberOfLayers
```
public int getNumberOfLayers()
```
    Returns the number of layers defined.
    
    Returns:
    
    The number of layers
  - getNumberOfLinks
```
public int getNumberOfLinks(NetworkLayer... optionalLayerParameter)
```
    Returns the number of links at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer
    
    Returns:
    
    The number of links
  - getNumberOfMulticastDemands
```
public int getNumberOfMulticastDemands(NetworkLayer... optionalLayerParameter)
```
    Returns the number of multicast demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The number of multicast demands
  - getNumberOfMulticastTrees
```
public int getNumberOfMulticastTrees(NetworkLayer... optionalLayerParameter)
```
    Returns the number of multicast trees at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The number of multicast trees
  - getNumberOfNodePairs
```
public int getNumberOfNodePairs()
```
    Returns the number of node pairs.
    
    Returns:
    
    The number of node pairs
  - getNumberOfNodes
```
public int getNumberOfNodes()
```
    Returns the number of network nodes,
    
    Returns:
    
    The number of nodes
  - getNumberOfResources
```
public int getNumberOfResources()
```
    Returns the number of resources (Resource) defined
    
    Returns:
    
    The number of defined resources
  - getNumberOfRoutes
```
public int getNumberOfRoutes(NetworkLayer... optionalLayerParameter)
```
    Returns the number of routes at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The number of routes
  - getNumberOfSRGs
```
public int getNumberOfSRGs()
```
    Returns the number of shared risk groups (SRGs) defined
    
    Returns:
    
    The number of defined shared risk groups
  - getPlotNodeLayoutCurrentlyActive
```
public String getPlotNodeLayoutCurrentlyActive()
```
    Returns the name (identifier) of the current node layout
    
    Returns:
    
    see above
  - getPlotNodeLayoutDefaultLayoutName
```
public String getPlotNodeLayoutDefaultLayoutName()
```
    Returns the name of the default node layout (this is a constant). This is different to the currenlty active layout
    
    Returns:
    
    see above
  - getResource
```
public Resource getResource(int index)
```
    Returns the resource with the given index
    
    Parameters:
    
    index - Resource index
    
    Returns:
    
    The Resource with the given index (null if it does not exist, index is lesser than zero or greater than the number of elements minus one)
  - getResourceFromId
```
public Resource getResourceFromId(long uid)
```
    Returns the resource with the given unique identifier.
    
    Parameters:
    
    uid - Resource unique id
    
    Returns:
    
    The resource with the given unique id (@code null if it does not exist)
  - getResourceIds
```
public ArrayList<Long> getResourceIds()
```
    Returns the array of resource ids (i-th position, corresponds to index i)
    
    Returns:
    
    The ArrayList of Resource unique ids
  - getResources
```
public List<Resource> getResources()
```
    Returns the array of resources (i-th position, corresponds to index i).
    
    Returns:
    
    The List of Resource obejects
  - getResources
```
public SortedSet<Resource> getResources(String type)
```
    Returns the set of resources in the network for the given type. If none resource exists for that type, an empty set is returned
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the set of resources
  - getResourcesAttachedToAnyNode
```
public SortedSet<Resource> getResourcesAttachedToAnyNode()
```
    Returns the set of resources which are attached to any node (that is, not unattached)
    
    Returns:
    
    see above
  - getRoute
```
public Route getRoute(int index,
                      NetworkLayer... optionalLayerParameter)
```
    Returns the route with the given index in the given layer. if no layer is provided, default layer is assumed
    
    Parameters:
    
    index - Route index
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The route with the given index (null if it does not exist, index is lesser than zero or greater than the number of elements minus one)
  - getRouteFromId
```
public Route getRouteFromId(long uid)
```
    Returns the route with the given unique identifier.
    
    Parameters:
    
    uid - Rute unique id
    
    Returns:
    
    The route with the given id (null if it does not exist)
  - getRouteIds
```
public ArrayList<Long> getRouteIds(NetworkLayer... optionalLayerParameter)
```
    Returns the array of route ids for the given layer (i-th position, corresponds to index i). If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The ArrayList of route ides
  - getRoutes
```
public List<Route> getRoutes(NetworkLayer... optionalLayerParameter)
```
    Returns the array of route ids for the given layer (i-th position, corresponds to index i). If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    the List of routes
  - getRoutesAreBackup
```
public List<Route> getRoutesAreBackup(NetworkLayer... optionalLayerParameter)
```
    Returns the list of routes which are not backup of any other route
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    the List of routes
  - getRoutesAreNotBackup
```
public List<Route> getRoutesAreNotBackup(NetworkLayer... optionalLayerParameter)
```
    Returns the list of routes which are backup of any other route
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    the List of routes
  - getRoutesDown
```
public SortedSet<Route> getRoutesDown(NetworkLayer... optionalLayerParameter)
```
    Returns the set of routes that are down (traverse a link or node that is failed). If no layer is provided, default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The SortedSet of routes that are down
  - getRoutesTraversingZeroCapacityLinks
```
public SortedSet<Route> getRoutesTraversingZeroCapacityLinks(NetworkLayer... optionalLayerParameter)
```
    Returns the set of routes that are traversing a link with zero capacity. If no layer is provided, default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    see above
  - getSiteNames
```
public SortedSet<String> getSiteNames()
```
    Returns the set of all site names defined in the network
    
    Returns:
    
    see above
  - getSiteNodes
```
public SortedSet<Node> getSiteNodes(String siteName)
```
    Given a site name, returns the set of nodes associated to that site, or an empty set if none
    
    Parameters:
    
    siteName - the name
    
    Returns:
    
    see above
  - getSRG
```
public SharedRiskGroup getSRG(int index)
```
    Returns the shared risk group with the given index
    
    Parameters:
    
    index - SRG index
    
    Returns:
    
    The shared risk group with the given index (null if it does not exist, index is lesser than zero or greater than the number of elements minus one)
  - getSRGFromId
```
public SharedRiskGroup getSRGFromId(long uid)
```
    Returns the shared risk group with the given unique identifier.
    
    Parameters:
    
    uid - SRG unique id
    
    Returns:
    
    The shared risk group with the given unique id (@code null if it does not exist)
  - getSRGIds
```
public ArrayList<Long> getSRGIds()
```
    Returns the array of shared risk group ids (i-th position, corresponds to index i)
    
    Returns:
    
    The ArrayList of Shared Risk Groups unique ids
  - getSRGs
```
public List<SharedRiskGroup> getSRGs()
```
    Returns the array of shared risk groups (i-th position, corresponds to index i).
    
    Returns:
    
    The List of Shared Risk Groups
  - getSrgsDynamic
```
public SortedSet<SharedRiskGroup> getSrgsDynamic()
```
    Returns the set of Srgs that are dynamically calculated
    
    Returns:
    
    see above
  - getTaggedDemands
```
public SortedSet<Demand> getTaggedDemands(String tag,
                                          NetworkLayer... optionalLayerParameter)
```
    Returns the set of demands in the given layer with the given tag. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    tag - the tag
    
    optionalLayerParameter - the layer (optional)
    
    Returns:
    
    the set (or an empty set if there are no elements to return)
  - getTaggedLayers
```
public SortedSet<NetworkLayer> getTaggedLayers(String tag)
```
    Returns the set of layers with the given tag.
    
    Parameters:
    
    tag - the tag
    
    Returns:
    
    the set (or an empty set if there are no elements to return)
  - getTaggedLinks
```
public SortedSet<Link> getTaggedLinks(String tag,
                                      NetworkLayer... optionalLayerParameter)
```
    Returns the set of links in the given layer with the given tag. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    tag - the tag
    
    optionalLayerParameter - the layer (optional)
    
    Returns:
    
    the set (or an empty set if there are no elements to return)
  - getTaggedMulticastDemands
```
public SortedSet<MulticastDemand> getTaggedMulticastDemands(String tag,
                                                            NetworkLayer... optionalLayerParameter)
```
    Returns the set of multicast demands in the given layer with the given tag. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    tag - the tag
    
    optionalLayerParameter - the layer (optional)
    
    Returns:
    
    the set (or an empty set if there are no elements to return)
  - getTaggedMulticastTrees
```
public SortedSet<MulticastTree> getTaggedMulticastTrees(String tag,
                                                        NetworkLayer... optionalLayerParameter)
```
    Returns the set of multicast trees in the given layer with the given tag. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    tag - the tag
    
    optionalLayerParameter - the layer (optional)
    
    Returns:
    
    the set (or an empty set if there are no elements to return)
  - getTaggedNodes
```
public SortedSet<Node> getTaggedNodes(String tag)
```
    Returns the set of nodes with the given tag.
    
    Parameters:
    
    tag - the tag
    
    Returns:
    
    the set (or an empty set if there are no elements to return)
  - getTaggedResources
```
public SortedSet<Resource> getTaggedResources(String tag)
```
    Returns the set of resources with the given tag.
    
    Parameters:
    
    tag - the tag
    
    Returns:
    
    the set (or an empty set if there are no elements to return)
  - getTaggedRoutes
```
public SortedSet<Route> getTaggedRoutes(String tag,
                                        NetworkLayer... optionalLayerParameter)
```
    Returns the set of routes in the given layer with the given tag. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    tag - the tag
    
    optionalLayerParameter - the layer (optional)
    
    Returns:
    
    the set (or an empty set if there are no elements to return)
  - getTaggedSrgs
```
public SortedSet<SharedRiskGroup> getTaggedSrgs(String tag)
```
    Returns the set of SRGs with the given tag.
    
    Parameters:
    
    tag - the tag
    
    Returns:
    
    the set (or an empty set if there are no elements to return)
  - getUnattachedResources
```
public SortedSet<Resource> getUnattachedResources()
```
    Returns the set of resources which are not attached to any node
    
    Returns:
    
    see above
  - getVectorAttributeValues
```
public DoubleMatrix1D getVectorAttributeValues(Collection<? extends NetworkElement> collection,
                                               String attributeKey)
```
    Retuns a vector with the values of all given network elements for the given attribute key.
    
    Important: Each element must have the attribute set and value must be of type double
    
    Parameters:
    
    collection - Network elements
    
    attributeKey - Attribute name
    
    Returns:
    
    The vector of values for the given attribute name for all network elements
  - getVectorDemandBlockedTraffic
```
public DoubleMatrix1D getVectorDemandBlockedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the blocked traffic per demand, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the blocked traffic per demand
  - getVectorDemandCarriedTraffic
```
public DoubleMatrix1D getVectorDemandCarriedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the carried traffic per demand, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector of carried traffic per demand
  - getVectorDemandOfferedTraffic
```
public DoubleMatrix1D getVectorDemandOfferedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the offered traffic per demand, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the offered traffic per demand
  - getVectorDemandTraversesOversubscribedLink
```
public DoubleMatrix1D getVectorDemandTraversesOversubscribedLink(NetworkLayer... optionalLayerParameter)
```
    Returns a vector where each index equals the demand index and the value is 1 if said demand traverses oversubscrined links, 0 otherwise. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector indicating if each demand traverses oversubscribed links
  - getVectorDemandWorseCasePropagationTimeInMs
```
public DoubleMatrix1D getVectorDemandWorseCasePropagationTimeInMs(NetworkLayer... optionalLayerParameter)
```
    Returns the vector with the worst propagation time (in ms) per demand at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the worst propagation time in ms per demand
  - getVectorLinkCapacity
```
public DoubleMatrix1D getVectorLinkCapacity(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the capacity per link, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the capacity per link
  - getVectorLinkCarriedTraffic
```
public DoubleMatrix1D getVectorLinkCarriedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the total carried traffic per link, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the total carried traffic per link
  - getVectorLinkLengthInKm
```
public DoubleMatrix1D getVectorLinkLengthInKm(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the length in km in the links, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the length un km per link
  - getVectorLinkOccupiedCapacity
```
public DoubleMatrix1D getVectorLinkOccupiedCapacity(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the total occupied capacity in the links, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the total occupied capacity per link
  - getVectorLinkOversubscribedTraffic
```
public DoubleMatrix1D getVectorLinkOversubscribedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the oversubscibed traffic (oversubscribed traffic being the sum of all carried traffic, minus the capacity, or 0 if such substraction is negative) in each link at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the oversubscribed traffic per link
  - getVectorLinkPropagationDelayInMiliseconds
```
public DoubleMatrix1D getVectorLinkPropagationDelayInMiliseconds(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the propagation delay in milliseconds in the links, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the propagation time per link
  - getVectorLinkPropagationSpeedInKmPerSecond
```
public DoubleMatrix1D getVectorLinkPropagationSpeedInKmPerSecond(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the propagation speed in km/s in the links, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the propagation speed in km/s per link
  - getVectorLinkSpareCapacity
```
public DoubleMatrix1D getVectorLinkSpareCapacity(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the spare capacity (available minus occupied, or zero if oversubscribed) per link, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the spare capacity per link
  - getVectorLinkUpState
```
public DoubleMatrix1D getVectorLinkUpState(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the up/down state in the links (1 up, 0 down), at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the up/down state in the links
  - getVectorLinkUtilization
```
public DoubleMatrix1D getVectorLinkUtilization(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the utilization per link, at the given layer. Utilization is measured as the total link occupied capacity by the link traffic divided by the total link capacity. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the utilization per link
  - getVectorMulticastDemandBlockedTraffic
```
public DoubleMatrix1D getVectorMulticastDemandBlockedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the blocked traffic per multicast demand, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the blocked traffic per multicast demand
  - getVectorMulticastDemandCarriedTraffic
```
public DoubleMatrix1D getVectorMulticastDemandCarriedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the carried traffic per multicast demand, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the carried traffic per multicast demand
  - getVectorMulticastDemandOfferedTraffic
```
public DoubleMatrix1D getVectorMulticastDemandOfferedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the offered traffic per multicast demand, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the offered traffic per multicast demand
  - getVectorMulticastDemandTraversesOversubscribedLink
```
public DoubleMatrix1D getVectorMulticastDemandTraversesOversubscribedLink(NetworkLayer... optionalLayerParameter)
```
    Returns the vector indicating wheter a multicast demnd traverses (1) or not (0) oversubscribes links at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector indicating if each multicast demand traverses oversubscribed links
  - getVectorMulticastDemandWorseCasePropagationTimeInMs
```
public DoubleMatrix1D getVectorMulticastDemandWorseCasePropagationTimeInMs(NetworkLayer... optionalLayerParameter)
```
    Returns the vector with the worst propagation time (in ms) per multicast demand at the given layer. i-th vector corresponds to i-th index of the element.. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the worst propagation time in ms per multicast demand
  - getVectorMulticastTreeAverageNumberOfHops
```
public DoubleMatrix1D getVectorMulticastTreeAverageNumberOfHops(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the avergage number of hops per multicast tree at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The average number of hops per multicast tree
  - getVectorMulticastTreeCarriedTraffic
```
public DoubleMatrix1D getVectorMulticastTreeCarriedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the carried traffic per multicast tree, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the carried traffic per multicast tree
  - getVectorMulticastTreeNumberOfLinks
```
public DoubleMatrix1D getVectorMulticastTreeNumberOfLinks(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the number of links per multicast tree, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the number of links per multicast tree
  - getVectorMulticastTreeOccupiedCapacity
```
public DoubleMatrix1D getVectorMulticastTreeOccupiedCapacity(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the occupied capacity traffic per multicast tree, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the occupied capacity per multicast tree
  - getVectorMulticastTreeOfferedTrafficOfAssociatedMulticastDemand
```
public DoubleMatrix1D getVectorMulticastTreeOfferedTrafficOfAssociatedMulticastDemand(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the offered traffic per multicast tree from its associated multicast demand, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the offered traffic per multicast tree from its associated multicast demand
  - getVectorNodeEgressUnicastTraffic
```
public DoubleMatrix1D getVectorNodeEgressUnicastTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the vector with the total incoming offered traffic per node at the given layer. i-th vector corresponds to i-th index of the element. if no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the total incoming offered traffic per node
  - getVectorNodeIngressUnicastTraffic
```
public DoubleMatrix1D getVectorNodeIngressUnicastTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns the vector with the total outgoing offered traffic per node at the given layer. i-th vector corresponds to i-th index of the element. if no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the total outgoing offered traffic per node
  - getVectorNodePopulation
```
public DoubleMatrix1D getVectorNodePopulation()
```
    Returns a vector with the population of the nodes. i-th vector corresponds to i-th index of the element
    
    Returns:
    
    see above
  - getVectorNodeUpState
```
public DoubleMatrix1D getVectorNodeUpState()
```
    Returns a vector with the up/down state of the nodes (1 up, 0 down). i-th vector corresponds to i-th index of the element
    
    Returns:
    
    The vector with the up/down state of the nodes.
  - getVectorResourceCapacity
```
public DoubleMatrix1D getVectorResourceCapacity()
```
    Returns a vector with as many elements as resources, containing the capacity (in the own resource capacity units), for each resource.
    
    Returns:
    
    The vector
  - getVectorResourceIsOfType
```
public DoubleMatrix1D getVectorResourceIsOfType(String type)
```
    Returns a vector with as many elements as resources, containing a 1 in coordinate of index i if the resource of index i is of the given type, a 0 if not.
    
    Parameters:
    
    type - the resource type
    
    Returns:
    
    The vector
  - getVectorResourceOccupiedCapacity
```
public DoubleMatrix1D getVectorResourceOccupiedCapacity()
```
    Returns a vector with as many elements as resources, containing the currently occupied capacity (in the own resource capacity units), for each resource.
    
    Returns:
    
    The vector
  - getVectorResourceProcessingTimeInMs
```
public DoubleMatrix1D getVectorResourceProcessingTimeInMs()
```
    Returns a vector with as many elements as resources, containing the processing time in ms for the traversig traffic, for each resource.
    
    Returns:
    
    The vector
  - getVectorRouteCarriedTraffic
```
public DoubleMatrix1D getVectorRouteCarriedTraffic(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the carried traffic per route, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the carried traffic per route
  - getVectorRouteFirstBackupRouteLengthInKm
```
public DoubleMatrix1D getVectorRouteFirstBackupRouteLengthInKm(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with one element per route, containing the length in km of the first defined backup path for such route. If a route has no backup path defined, an exception is thrown. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector
  - getVectorRouteFirstBackupRouteNumberOfLinks
```
public DoubleMatrix1D getVectorRouteFirstBackupRouteNumberOfLinks(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with one element per route, containing the number of links of the first defined backup path for such route. If a route has no backup path defined, an exception is thrown. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector
  - getVectorRouteLengthInKm
```
public DoubleMatrix1D getVectorRouteLengthInKm(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the length in km per route, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the length in km per route
  - getVectorRouteNumberOfLinks
```
public DoubleMatrix1D getVectorRouteNumberOfLinks(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the number of links per route, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the number of links per route
  - getVectorRouteOccupiedCapacity
```
public DoubleMatrix1D getVectorRouteOccupiedCapacity(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the occupied capacity traffic per route, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the occupied traffic per route
  - getVectorRouteOfferedTrafficOfAssociatedDemand
```
public DoubleMatrix1D getVectorRouteOfferedTrafficOfAssociatedDemand(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the offered traffic (from its associated demand) per route at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    The vector with the offered traffic per route (from is associated demand)
  - getVectorRoutePropagationDelayInMiliseconds
```
public DoubleMatrix1D getVectorRoutePropagationDelayInMiliseconds(NetworkLayer... optionalLayerParameter)
```
    Returns a vector with the propagation delay in seconds per route, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    The vector with the propagation delay in seconds per route
  - getVectorSRGAvailability
```
public DoubleMatrix1D getVectorSRGAvailability()
```
    Returns a vector with the availability per Shared Risk Group (SRG).
    
    Returns:
    
    The vector with the availability per Shared Risk group
  - hasDemands
```
public boolean hasDemands(NetworkLayer... optionalLayerParameter)
```
    Returns true if the network has one or more demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    True if the network has demands at the given layer, false otherwise
  - hasForwardingRules
```
public boolean hasForwardingRules(NetworkLayer... optionalLayerParameter)
```
    Returns true if the network has at least one non-zero forwarding rule splitting ratio in any demand-link pair, in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - network layer (optional)
    
    Returns:
    
    True if the network has at least one forwarding rule, false otherwise
  - hasLinks
```
public boolean hasLinks(NetworkLayer... optionalLayerParameter)
```
    Returns true if the network has one or more links at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    True if the network has one or more links, false otherwise
  - hasMulticastDemands
```
public boolean hasMulticastDemands(NetworkLayer... optionalLayerParameter)
```
    Returns true if the network has one or more multicast demands at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    True if the network has one or more multicast demand, false otherwise
  - hasMulticastTrees
```
public boolean hasMulticastTrees(NetworkLayer... optionalLayerParameter)
```
    Returns true if the network has one or more multicast trees at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    True if the network has one or more multicast trees, false otherwise
  - hasNodes
```
public boolean hasNodes()
```
    Returns true if the network has nodes.
    
    Returns:
    
    True if the network has nodes, false otherwise
  - hasResources
```
public boolean hasResources()
```
    Returns true if the network has one or more resources (Resource) defined.
    
    Returns:
    
    True if the network has resources defined, false otherwise
  - hasRoutes
```
public boolean hasRoutes(NetworkLayer... optionalLayerParameter)
```
    Returns true if the network has one or moreroutes at the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    True if the network has one or more routes, false otherwise
  - hasSRGs
```
public boolean hasSRGs()
```
    Returns true if the network has one or more shared risk groups (SRGs) defined.
    
    Returns:
    
    True if the network has SRGs defined, false otherwise
  - hasUnicastRoutingLoops
```
public boolean hasUnicastRoutingLoops(NetworkLayer... optionalLayerParameter)
```
    Returns true if the network has at least one routing cycle at the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    True if there is at least one routing cycle, false otherwise
  - isDeepCopy
```
public boolean isDeepCopy(NetPlan np2)
```
    Returns true if the given NetPlan object contains the same network than this, meaning that all the network elements are a copy in every aspect. In particular, saving in disk a design and then loading it again, should produce a network that is a deep copy of the original. Also, creating a new network using the copy method, should be also a deep copy
    
    Parameters:
    
    np2 - The NetPlan object to compare to
    
    Returns:
    
    true if the given network is a copy of this one
  - isLayerCouplingValid
```
public boolean isLayerCouplingValid(NetworkLayer lowerLayer,
                                    NetworkLayer upperLayer)
```
    Indicates whether or not a further coupling between two layers would be valid. This can be used to check if a new coupling would create cycles in the topology of layers, that is, if layer hierarchy is not broken.
    
    Parameters:
    
    lowerLayer - Network lower layer
    
    upperLayer - Network upper layer
    
    Returns:
    
    True if coupling between both input layers is valid, false otherwise
  - isModifiable
```
public boolean isModifiable()
```
  - isMulticastRoutingBifurcated
```
public boolean isMulticastRoutingBifurcated(NetworkLayer... optionalLayerParameter)
```
    Returns true if in the given layer, the traffic of any multicast demand is carried by more than one multicast tree. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    True if traffic from at least one multicast demand is carried trhough two or more multicast trees, false otherwise
  - isMultilayer
```
public boolean isMultilayer()
```
    Returns true if the network has more than one layer.
    
    Returns:
    
    True if the network has two or more layers, false otherwise
  - isSingleLayer
```
public boolean isSingleLayer()
```
    Returns true if the network has just one layer
    
    Returns:
    
    True if network has only one layer, false otherwise
  - isUnicastRoutingBifurcated
```
public boolean isUnicastRoutingBifurcated(NetworkLayer... optionalLayerParameter)
```
    Returns true if in the given layer, the traffic of any demand is carried by more than one route (in SOURCE_ROUTING), or a node sends traffic of a demand to more than one link (in HOP_BY_HOP_ROUTING). If no layer is provided, the default layer is assumed
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    Returns:
    
    True if unicast traffic is bifurcated (see description), false otherwise
  - isUp
```
public boolean isUp(Collection<? extends NetworkElement> col)
```
    Indicates whether or not a path, multicast tree or arbitrary collection of links and/or resources and/or nodes is up and belonging to this netPlan object (so they were not removed), and false otherwise
    
    Parameters:
    
    col - the collection
    
    Returns:
    
    see above
  - loadFromFile
```
public static NetPlan loadFromFile(File file)
```
    Static factory method to get a NetPlan object from a .n2p file.
    
    Parameters:
    
    file - Input file
    
    Returns:
    
    A network design
  - mergeIntoThisDesign
```
public NetPlan mergeIntoThisDesign(NetPlan otherDesign)
```
    Replaces the partition of the current design by this design. The node ids are used to match this and other design. Nodes that are in both are assumed to be the scope of the partition. Then, all the links, demands etc. among these nodes are removed from current design, and all the elements in the other design are added to this. This operation is idempotent: merging x with x is x, merging x with y and again with y, is the same as merging x with y just once
    
    Parameters:
    
    otherDesign - The design to merge with
    
    Returns:
    
    this (for convenience only)
  - removeAllDemands
```
public void removeAllDemands(NetworkLayer... optionalLayerParameter)
```
    Removes all the demands defined in the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
  - removeAllForwardingRules
```
public void removeAllForwardingRules(NetworkLayer... optionalLayerParameter)
```
    Removes all the forwarding rules in the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
  - removeAllLinks
```
public void removeAllLinks(NetworkLayer... optionalLayerParameter)
```
    Removes all the links defined in the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
  - removeAllLinksUnused
```
public void removeAllLinksUnused(double toleranceCapacityValueToConsiderUnusedLink,
                                 NetworkLayer... optionalLayerParameter)
```
    Removes all the unsused links (those whith lesser capacity than toleranceCapacityValueToConsiderUnusedLink) defined in the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    toleranceCapacityValueToConsiderUnusedLink - Tolerance capacity to consider a link unsused
  - removeAllMulticastDemands
```
public void removeAllMulticastDemands(NetworkLayer... optionalLayerParameter)
```
    Removes all the multicast demands defined in the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
  - removeAllMulticastTrees
```
public void removeAllMulticastTrees(NetworkLayer... optionalLayerParameter)
```
    Removes all the multicast trees defined in the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
  - removeAllMulticastTreesUnused
```
public void removeAllMulticastTreesUnused(double toleranceTrafficAndCapacityValueToConsiderUnusedTree,
                                          NetworkLayer... optionalLayerParameter)
```
    Removes all the multicast trees carrying no traffic and occupying no link capacity (even in the no failure state) defined in the given layer. If no layer is provided, default layer is used.
    
    Parameters:
    
    toleranceTrafficAndCapacityValueToConsiderUnusedTree - Tolerance capacity to consider a link unsused
    
    optionalLayerParameter - Network layer (optional)
  - removeAllNetworkLayers
```
public void removeAllNetworkLayers()
```
    Removes all the network layers (everything but the nodes and the SRGs). Removes all the links, demands and multicast demands of the defualt layer, it does not remove it
  - removeAllNodes
```
public void removeAllNodes()
```
    Removes all the network nodes.
  - removeAllResources
```
public void removeAllResources()
```
    Removes all the resources.
  - removeAllRoutes
```
public void removeAllRoutes(NetworkLayer... optionalLayerParameter)
```
    Removes all the routes defined in the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
  - removeAllRoutesUnused
```
public void removeAllRoutesUnused(double toleranceTrafficAndCapacityValueToConsiderUnusedRoute,
                                  NetworkLayer... optionalLayerParameter)
```
    Removes all the routes defined in the given layer that do not carry traffic nor occupy link capacity in the given layer (even in a no-failure state). If no layer is provided, default layer is assumed.
    
    Parameters:
    
    toleranceTrafficAndCapacityValueToConsiderUnusedRoute - Tolerance traffic to consider a route unused
    
    optionalLayerParameter - Network layer (optional)
  - removeAllSRGs
```
public void removeAllSRGs()
```
    Removes all the shared risk groups.
  - removeAllUnicastRoutingInformation
```
public void removeAllUnicastRoutingInformation(NetworkLayer... optionalLayerParameter)
```
    Removes all the routing information (unicast and multicast) for the given layer, irrespective of the routing type setting. For source routing, all routes are removed. For hop-by-hop routing, all forwarding rules are removed. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
  - removeGlobalPlanningDomain
```
public void removeGlobalPlanningDomain(String planningDomain)
```
    Removes a global planning domain, if no elements have it assigned, and there is left at least one planning domain
    
    Parameters:
    
    planningDomain - The name of the planning domain
  - removeNetworkLayer
```
public void removeNetworkLayer(NetworkLayer... optionalLayerParameter)
```
    Removes a layer, and any associated link, demand, route, or forwarding rule. If this layer is the default, the new default layer is the one with index 0 (the smallest identifier)
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
  - removePlotNodeLayout
```
public void removePlotNodeLayout(String plotLayoutToRemove)
```
    Removes the indicated layout, that cannot be the currently active layout, nor the default layout
    
    Parameters:
    
    plotLayoutToRemove - see above
  - renameGlobalPlanningDomain
```
public void renameGlobalPlanningDomain(String oldName,
                                       String newName)
```
    Change globally the name of a planning domain, updating the information in all the elements
    
    Parameters:
    
    oldName - the old name (should exist)
    
    newName - the new name (should not exist)
  - reset
```
public void reset()
```
    Resets the state of the network to an empty NetPlan.
  - restrictDesign
```
public NetPlan restrictDesign(SortedSet<Node> selectedNodes)
```
    First computes the nodes to keep in the planning: these are the selected nodes, the nodes involved in the demands/mDemands between them in this layer, the nodes involved in the links at this layer that carry traffic between the selected nodes, and the nodes associated to the links/demands at lower layers, that carry the traffic between the selected nodes in the given layer, or carry traffic at lower layers, of the links at this layer between the selected nodes. After computing such nodes, removes from the design all the nodes outside such set. If keepConnectivitySets is set, all the links in the shortest path between the selected nodes in the given layer, and those that would carry its traffic, are kept. Then, the resulting design has the same connected components than the original graph.
    
    Parameters:
    
    selectedNodes - the selected nodes
    
    Returns:
    
    this
  - saveToFile
```
public void saveToFile(File file)
```
    Saves the current network plan to a given file. If extension .n2p is not in the file name, it will be added automatically.
    
    Parameters:
    
    file - Output file
  - saveToOutputStream
```
public void saveToOutputStream(OutputStream outputStream)
```
    Saves the current network plan to a given output stream.
    
    Parameters:
    
    outputStream - Output stream
  - setAllLinksFailureState
```
public void setAllLinksFailureState(boolean setAsUp,
                                    NetworkLayer... optionalLayerParameter)
```
    Sets the failure state (up or down) for all the links in the given layer. If no layer is provided, the default layer is assumed.
    
    Parameters:
    
    setAsUp - true up, false down
    
    optionalLayerParameter - Network layer (optional)
  - setAllNodesFailureState
```
public void setAllNodesFailureState(boolean setAsUp)
```
    Sets the failure state (up or down) for all the nodes.
    
    Parameters:
    
    setAsUp - true up, false down
  - setDemandTrafficUnitsName
```
public void setDemandTrafficUnitsName(String demandTrafficUnitsName,
                                      NetworkLayer... optionalLayerParameter)
```
    Sets the name of the units in which the offered traffic is measured (e.g. "Gbps") at the given layer. If no layer is provided, default layer is assumed.
    
    Parameters:
    
    demandTrafficUnitsName - Traffic units name
    
    optionalLayerParameter - Network layer (optional)
  - setForwardingRule
```
public double setForwardingRule(Demand demand,
                                Link link,
                                double splittingRatio)
```
    Adds a new forwarding rule (or override an existing one), to the layer of the demand and link (must be in the same layer).
    
    Important: Routing type must be HOP_BY_HOP_ROUTING.
    
    Parameters:
    
    demand - Demand
    
    link - Link
    
    splittingRatio - Splitting ratio (fraction of traffic from demand 'd' entering to the origin node of link 'e', going through link 'e'). Must be equal or greater than 0 and equal or lesser than 1.
    
    Returns:
    
    The previous value of the forwarding rule
  - setForwardingRules
```
public void setForwardingRules(Collection<Demand> demands,
                               Collection<Link> links,
                               Collection<Double> splittingFactors,
                               boolean removePreviousRulesAffectedDemands)
```
    Adds a set of forwarding rules (or override existing ones). Demands, links and ratio are processed sequentially. All the elements must be in the same layer.
    
    Important: Routing type must be HOP_BY_HOP_ROUTING.
    
    Parameters:
    
    demands - Demands
    
    links - Links
    
    splittingFactors - Splitting ratios (fraction of traffic from demand 'd' entering to the origin node of link 'e', going through link 'e'). Each value must be equal or greater than 0 and equal or lesser than 1.
    
    removePreviousRulesAffectedDemands - Inclue true or not false unused rules
  - setForwardingRules
```
public void setForwardingRules(DoubleMatrix2D f_de,
                               Set<Demand> demandsToUpdate,
                               NetworkLayer... optionalLayerParameter)
```
    Sets the forwarding rules for the given design, only for the demands that are hop-by-hop. Source routed demands are untouched.
    
    Parameters:
    
    f_de - For each demand d (d = 0 refers to the first demand in demandIds, d = 1 refers to the second one, and so on), and each link e (e = 0 refers to the first link in NetPlan object, e = 1 refers to the second one, and so on), f_de[d][e] sets the fraction of the traffic from demand d that arrives (or is generated in) node a(e) (the origin node of link e), that is forwarded through link e. It must hold that for every node n different of b(d), the sum of the fractions f_te along its outgoing links must be lower or equal than 1
    
    demandsToUpdate - Demands to update
    
    optionalLayerParameter - Network layer (optional)
  - setLinkCapacityUnitsName
```
public void setLinkCapacityUnitsName(String name,
                                     NetworkLayer... optionalLayerParameter)
```
    Sets the name of the units in which the link capacity is measured (e.g. "Gbps") at the given layer. If no ayer is provided, the default layer is assumed.
    
    Parameters:
    
    name - Capacity units name
    
    optionalLayerParameter - Network layer (optional)
  - setLinksAndNodesFailureState
```
public void setLinksAndNodesFailureState(Collection<Link> linksToSetAsUp,
                                         Collection<Link> linksToSetAsDown,
                                         Collection<Node> nodesToSetAsUp,
                                         Collection<Node> nodesToSetAsDown)
```
    Changes the failure state of the links and updates the routes/trees (they do not carry traffic nor occupy capacity), and hop-by-hop routing (no traffic is forwarded in links down)
    
    Parameters:
    
    linksToSetAsUp - Links to set as up
    
    linksToSetAsDown - Links to set as down
    
    nodesToSetAsUp - Nodes to set as up
    
    nodesToSetAsDown - Nodes to set as down
  - setModifiableState
```
public boolean setModifiableState(boolean isModifiable)
```
    Sets the NetPlan so it cannot be modified
    
    Parameters:
    
    isModifiable - }If true, the object can be modified, false otherwise
    
    Returns:
    
    The previous modifiable state
  - setNetworkLayerDefault
```
public void setNetworkLayerDefault(NetworkLayer layer)
```
    Sets the default network layer.
    
    Parameters:
    
    layer - The default network layer
  - setPlotNodeLayoutCurrentlyActive
```
public void setPlotNodeLayoutCurrentlyActive(String newCurrentPlotNodeLayout)
```
    Returns all the names (identifiers) of the current node layout
    
    Parameters:
    
    newCurrentPlotNodeLayout - see above
  - setRoutingFromDemandLinkCarriedTraffic
```
public void setRoutingFromDemandLinkCarriedTraffic(DoubleMatrix2D x_de,
                                                   boolean xdeValueAsFractionsRespectToDemandOfferedTraffic,
                                                   boolean removeCycles,
                                                   Set<Demand> demandsToSetRouting,
                                                   NetworkLayer... optionalLayerParameter)
```
    Adds traffic routes (or forwarding rules, depending on the routing type) from demand-link routing at the given layer. If no layer is provided, default layer is assumed. If the routing is SOURCE-ROUTING, the new routing will have no closed nor open loops. If the routing is HOP-BY-HOP routing, the new routing can have open loops. However, if the routing has closed loops (which were not removed), a ClosedCycleRoutingException will be thrown.
    
    Parameters:
    
    x_de - Matrix containing the amount of traffic from demand d (rows) which traverses link e (columns)
    
    xdeValueAsFractionsRespectToDemandOfferedTraffic - If true, {code x_de} contains the fraction of the carried traffic (between 0 and 1)
    
    removeCycles - If true, the open and closed loops are eliminated from the routing before any processing is done. The form in which this is done guarantees that the resulting routing uses the same or less traffic in the links for each destination than the original routing. For removing the cycles, the method calls to removeCyclesFrom_xte using the default ILP solver defined in Net2Plan, and no limit in the maximum solver running time.
    
    optionalLayerParameter - Network layer (optional)
    
    demandsToSetRouting - Demands to set routing
  - setRoutingFromDestinationLinkCarriedTraffic
```
public void setRoutingFromDestinationLinkCarriedTraffic(DoubleMatrix2D x_te,
                                                        boolean removeCycles,
                                                        NetworkLayer... optionalLayerParameter)
```
    Adds traffic routes (or forwarding rules, depending on the routing type) from destination-link routing at the given layer. If no layer is provided, default layer is assumed. If the routing is SOURCE-ROUTING, the new routing will have no closed nor open loops. If the routing is HOP-BY-HOP routing, the new routing can have open loops. However, if the routing has closed loops (which were not removed), a ClosedCycleRoutingException will be thrown
    
    Parameters:
    
    x_te - For each destination node t (rows), and each link e (columns), f_te[t][e] represents the traffic targeted to node t that arrives (or is generated in) node a(e) (the origin node of link e), that is forwarded through link e
    
    removeCycles - If true, the open and closed loops are eliminated from the routing before any processing is done. The form in which this is done guarantees that the resulting routing uses the same or less traffic in the links for each destination than the original routing. For removing the cycles, the method calls to removeCyclesFrom_xte using the default ILP solver defined in Net2Plan, and no limit in the maximum solver running time.
    
    optionalLayerParameter - Network layer (optional)
  - setRoutingTypeAllDemands
```
public void setRoutingTypeAllDemands(Constants.RoutingType newRoutingType,
                                     NetworkLayer... optionalLayerParameter)
```
    Sets the routing type at the given layer. If there is some previous routing information, it will be converted to the new type. If no layer is provided, default layer is assumed. In the conversion from HOP-BY-HOP to SOURCE-ROUTING: (i) the demands with open loops are routed so these loops are removed, and the resulting routing consumes the same or less bandwidth in the demand traversed links, (ii) the demands with closed loops are routed so that the traffic that enters the closed loops is not carried. These modifications are done since open or close loops would require routes with an infinite number of links to be fairly represented.
    
    In the conversion to HOP-BY-HOP: An exception is thrown if a demand is service chain demand (since this information would be lost in the hop-by-bop representation). Also, in this conversion, some information can be lost (so a conversion back to SOURCE ROUTING will not produce the original network): the conversion uses the route carried traffics, and discards the information of the the routes occupied capacities in the links. A conversion back will put all the occupied capacities of the routes, equal to the carried traffics (so the original occupied links capacities would be lost, if different).
    
    Parameters:
    
    optionalLayerParameter - Network layer (optional)
    
    newRoutingType - RoutingType
  - setTrafficMatrix
```
public void setTrafficMatrix(DoubleMatrix2D trafficMatrix,
                             Constants.RoutingType routingTypeDemands,
                             NetworkLayer... optionalLayerParameter)
```
    Sets the traffic demands at the given layer from a given traffic matrix, removing any previous demand. If no layer is provided, default layer is assumed.
    
    Important: Matrix values must be strictly non-negative and matrix size have to be NxN (where N is the number of nodes)
    
    Parameters:
    
    routingTypeDemands - Routing type
    
    optionalLayerParameter - Network layer (optional
    
    trafficMatrix - Traffic matrix
    
    Since:
    
    0.3.1
  - setVectorAttributeValues
```
public void setVectorAttributeValues(Collection<? extends NetworkElement> collection,
                                     String attributeKey,
                                     DoubleMatrix1D values)
```
    Sets the given attributes values to all the given network elements.
    
    Parameters:
    
    collection - Network elements
    
    attributeKey - Attribute name
    
    values - Attribute values (must have the same size as collection
  - setVectorDemandOfferedTraffic
```
public void setVectorDemandOfferedTraffic(DoubleMatrix1D offeredTrafficVector,
                                          NetworkLayer... optionalLayerParameter)
```
    Sets the vector of the offered traffic per demand, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    offeredTrafficVector - Offered traffic vector
    
    optionalLayerParameter - Network layer (optional)
  - setVectorLinkCapacity
```
public void setVectorLinkCapacity(DoubleMatrix1D linkCapacities,
                                  NetworkLayer... optionalLayerParameter)
```
    Sets the vector of the link capacities, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    linkCapacities - Link capacities
    
    optionalLayerParameter - Network layer (optional)
  - setVectorMulticastDemandOfferedTraffic
```
public void setVectorMulticastDemandOfferedTraffic(DoubleMatrix1D offeredTrafficVector,
                                                   NetworkLayer... optionalLayerParameter)
```
    Sets the vector of the offered traffic per multicast demand, at the given layer. i-th vector corresponds to i-th index of the element. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    offeredTrafficVector - Offered traffic vector
    
    optionalLayerParameter - Network layer (optional)
  - setVectorMulticastTreeCarriedTrafficAndOccupiedLinkCapacities
```
public void setVectorMulticastTreeCarriedTrafficAndOccupiedLinkCapacities(DoubleMatrix1D carriedTraffic,
                                                                          DoubleMatrix1D occupiedLinkCapacity,
                                                                          NetworkLayer... optionalLayerParameter)
```
    Sets the vector of the multicast trees carried traffics and occupied link capacities, at the given layer. i-th vector corresponds to i-th index of the element. If occupied link capacities are null, the same amount as the carried traffic is assumed. If no layer is provided, the defaulf layer is assumed.
    
    Parameters:
    
    carriedTraffic - Carried traffic vector
    
    occupiedLinkCapacity - Occupied link capacity vector
    
    optionalLayerParameter - Network layer (optional)
  - setVectorRouteCarriedTrafficAndOccupiedLinkCapacities
```
public void setVectorRouteCarriedTrafficAndOccupiedLinkCapacities(DoubleMatrix1D carriedTraffic,
                                                                  DoubleMatrix1D occupiedLinkCapacity,
                                                                  NetworkLayer... optionalLayerParameter)
```
    Sets the vector of the route carried traffics and occupied link capacities, at the given layer. i-th vector corresponds to i-th index of the element. If occupied link capacities are null, the same amount as the carried traffic is assumed. If no layer is provided, the defaulf layer is assumed,
    
    Parameters:
    
    carriedTraffic - Carried traffic vector
    
    occupiedLinkCapacity - Occupied link capacity vector
    
    optionalLayerParameter - Network layer (optional)
  - toString
```
public String toString()
```
    Returns a String representation of the network design.
    
    Overrides:
    
    toString in class NetworkElement
    
    Returns:
    
    String representation of the network design
    
    Since:
    
    0.2.0
  - toString
```
public String toString(Collection<NetworkLayer> layers)
```
    Returns a String representation of the network design only for the given layers.
    
    Parameters:
    
    layers - Network layers
    
    Returns:
    
    String representation of the network design

Class NetPlan

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

PLOTLAYTOUT_DEFAULTNODELAYOUTGUINAME

PLOTLAYTOUT_DEFAULTNODELAYOUTNAME

Constructor Detail

NetPlan

NetPlan

NetPlan

Method Detail

addDemand

addDemandBidirectional

addDemandsFromTrafficMatrix

addGlobalPlanningDomain

addLayer

addLayerFrom

addLink

addLinkBidirectional

addMulticastDemand

addMulticastTree

addMulticastTreesFromCandidateTreeList

addNode

addPlotNodeLayout

addResource

addRoute

addRoutesAndBackupRoutesFromCandidate11PathList

addRoutesFromCandidatePathList

addServiceChain

addSRG

addSRGDynamic

assignFrom

checkCachesConsistency

checkContiguousPath

checkInThisNetPlanOptionalLayerParameter

checkMatrixDemandLinkCarriedTrafficFlowConservationConstraints

checkMatrixDestinationLinkCarriedTrafficFlowConservationConstraints

computeMulticastCandidatePathList

computeMulticastCandidatePathList

computeMulticastTreeCostVector

computeRouteCostVector

computeUnicastCandidate11PathList

computeUnicastCandidate11ServiceChainList

computeUnicastCandidatePathList

computeUnicastCandidateServiceChainList

copy

copyFrom

getAllLinksPerQosOccupationAndQosViolationMap

getAllPlotNodeLayoutsDefined

getAttributes

getAttributeValues

getDemand

getDemandFromId

getDemandIds

getDemands

getDemandsBlocked

getDemandsCoupled

getDemandsHopByHopRouted

getDemandsSourceRouted

getDemandTrafficUnitsName

getForwardingRuleCarriedTraffic

getForwardingRules

getForwardingRuleSplittingFactor

getGlobalPlanningDomainNodes

getGlobalPlanningDomains

getIds

getIndexes

getLink

getLinkCapacityUnitsName

getLinkFromId

getLinkIds

getLinks

getLinksAreBottleneck

getLinksCoupledToMulticastDemands

getLinksCoupledToUnicastDemands

getLinksDown

getLinksDownAllLayers