| Package | Description | 
|---|---|
| com.net2plan.interfaces.networkDesign | 
 Provides a set of classes and interfaces for the network design tool. 
 | 
| com.net2plan.interfaces.simulation | 
 Provides a set of classes for the online simulator tool. 
 | 
| com.net2plan.libraries | 
 Provides a set of useful libraries to develop algorithms and reports. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
NetPlan | 
NetPlan.copy()
Returns a deep copy of the current design. 
 | 
NetPlan | 
NetPlan.getLayer(long layerId)
Returns a copy of the current network design where only the given layer 
 is present. 
 | 
static NetPlan | 
NetPlan.loadFromFile(File file)
Static factory method to get a  
NetPlan from a .n2p file. | 
static NetPlan | 
NetPlan.loadFromInputStream(InputStream inputStream)
Static factory method to get a  
NetPlan from an input stream. | 
NetPlan | 
NetPlan.unmodifiableView()
Returns an unmodifiable view of the network. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
NetPlan.assignFrom(NetPlan netPlan)
Assigns the information from the input  
NetPlan. | 
void | 
NetPlan.copyFrom(NetPlan netPlan)
Removes all the current information from the current  
NetPlan and copy the 
 information from the input NetPlan. | 
void | 
NetPlan.copyFrom(NetPlan netPlan,
        Set<Long> layerIds)
Removes all the current information from the  
NetPlan and copy the 
 information all the specified layers from the input NetPlan. | 
long | 
NetPlan.copyLayerFrom(NetPlan netPlan)
Copies the default layer from a given network design as a new layer. 
 | 
long | 
NetPlan.copyLayerFrom(NetPlan netPlan,
             long layerId)
Copies a given layer from a given network as a new layer. 
 | 
String | 
IAlgorithm.executeAlgorithm(NetPlan netPlan,
                Map<String,String> algorithmParameters,
                Map<String,String> net2planParameters)
Execute the algorithm. 
 | 
String | 
IReport.executeReport(NetPlan netPlan,
             Map<String,String> reportParameters,
             Map<String,String> net2planParameters)
Executes a report. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ICombinedEventGenerator.initialize(NetPlan initialNetPlan,
          NetPlan currentNetPlan,
          Map<String,String> algorithmParameters,
          Map<String,String> simulationParameters,
          Map<String,String> net2planParameters)  | 
void | 
ICombinedEventProcessor.initialize(NetPlan initialNetPlan,
          NetPlan currentNetPlan,
          Map<String,String> algorithmParameters,
          Map<String,String> simulationParameters,
          Map<String,String> net2planParameters)  | 
abstract void | 
IEventGenerator.initialize(NetPlan initialNetPlan,
          NetPlan currentNetPlan,
          Map<String,String> algorithmParameters,
          Map<String,String> simulationParameters,
          Map<String,String> net2planParameters)
Initializes the algorithm (i.e. reading input parameters). 
 | 
abstract void | 
IEventProcessor.initialize(NetPlan initialNetPlan,
          NetPlan currentNetPlan,
          Map<String,String> algorithmParameters,
          Map<String,String> simulationParameters,
          Map<String,String> net2planParameters)
Initializes the algorithm (i.e. reading input parameters). 
 | 
abstract void | 
ICombinedEventGenerator.processEvent(NetPlan currentNetPlan,
            SimEvent event)  | 
abstract void | 
ICombinedEventProcessor.processEvent(NetPlan currentNetPlan,
            SimEvent event)  | 
abstract void | 
IEventGenerator.processEvent(NetPlan currentNetPlan,
            SimEvent event)
Processes the next event in the future event list. 
 | 
abstract void | 
IEventProcessor.processEvent(NetPlan currentNetPlan,
            SimEvent event)
Processes the next event in the future event list. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
WDMUtils.checkConsistency(NetPlan netPlan)
Performs extra checks to those applicable to every network design, especially
 focused on WDM networks. 
 | 
static void | 
WDMUtils.checkConsistency(NetPlan netPlan,
                long layerId)
Performs extra checks to those applicable to every network design, especially
 focused on WDM networks. 
 | 
static List<String> | 
NetworkPerformanceMetrics.checkNetworkState(NetPlan netPlan,
                 Map<String,String> net2planParameters)
Checks the current network state and, maybe, returns some warnings about 
 link oversubscription, demand blocking, and so on. 
 | 
static Quadruple<Map<Pair<Long,Long>,Double>,Map<Pair<Long,Long>,Double>,Map<Long,Double>,Map<Long,Double>> | 
IPUtils.computeCarriedTrafficFromIGPWeights(NetPlan netPlan,
                                   long layerId,
                                   Map<Long,Double> linkWeightMap)
Computes the resulting carried traffic according to a link weight setting 
 and OSPF/ECMP routing. 
 | 
static Quadruple<Map<Pair<Long,Long>,Double>,Map<Pair<Long,Long>,Double>,Map<Long,Double>,Map<Long,Double>> | 
IPUtils.computeCarriedTrafficFromIGPWeights(NetPlan netPlan,
                                   Map<Long,Double> linkWeightMap)
Computes the resulting carried traffic according to a link weight setting 
 and OSPF/ECMP routing. 
 | 
static cern.colt.matrix.tdouble.DoubleMatrix2D | 
SRGUtils.computeFailureState2LinkUnavailabilityMatrix(NetPlan netPlan,
                                            List<Set<Long>> F_s)
Given a network design with a set of shared-risk groups (SRGs) and a set 
 of failure states, each of them containing the associated set of simultaneous 
 SRG failures, the failure state-link unavailability matrix. 
 | 
static cern.colt.matrix.tdouble.DoubleMatrix2D | 
SRGUtils.computeFailureState2LinkUnavailabilityMatrix(NetPlan netPlan,
                                            long layerId,
                                            List<Set<Long>> F_s)
Given a network design with a set of shared-risk groups (SRGs) and a set 
 of failure states, each of them containing the associated set of simultaneous 
 SRG failures, the failure state-link unavailability matrix. 
 | 
static cern.colt.matrix.tdouble.DoubleMatrix2D | 
SRGUtils.computeSRG2LinkUnavailabilityMatrix(NetPlan netPlan)
Given a network design with a set of shared-risk groups (SRGs), it computes 
 the SRG-link unavailability matrix. 
 | 
static cern.colt.matrix.tdouble.DoubleMatrix2D | 
SRGUtils.computeSRG2LinkUnavailabilityMatrix(NetPlan netPlan,
                                   long layerId)
Given a network design with a set of shared-risk groups (SRGs), it computes 
 the SRG-link unavailability matrix. 
 | 
static void | 
SRGUtils.configureSRGs(NetPlan netPlan,
             double defaultMTTF,
             double defaultMTTR,
             SRGUtils.SharedRiskModel sharedRiskModel,
             boolean removeExistingSRGs)
Configures the SRGs into the network design at the first layer. 
 | 
static void | 
SRGUtils.configureSRGs(NetPlan netPlan,
             long layerId,
             double defaultMTTF,
             double defaultMTTR,
             SRGUtils.SharedRiskModel sharedRiskModel,
             boolean removeExistingSRGs)
Configures the SRGs into the network design at the given layer. 
 | 
static int | 
WDMUtils.getFiberNumWavelengths(NetPlan netPlan,
                      long fiberId)
Returns the number of wavelengths for the given fiber. 
 | 
static int | 
WDMUtils.getFiberNumWavelengths(NetPlan netPlan,
                      long layerId,
                      long fiberId)
Returns the number of wavelengths for the given fiber. 
 | 
static Map<Long,Integer> | 
WDMUtils.getFiberNumWavelengthsMap(NetPlan netPlan)
Returns the total number of wavelengths in each fiber. 
 | 
static Map<Long,Integer> | 
WDMUtils.getFiberNumWavelengthsMap(NetPlan netPlan,
                         long layerId)
Returns the total number of wavelengths in each fiber. 
 | 
static int[] | 
WDMUtils.getFiberNumWavelengthsVector(NetPlan netPlan)
Returns the total number of wavelengths in each fiber, where item 0 corresponds 
 to first fiber in the network, item 1 to the second one, and so on. 
 | 
static int[] | 
WDMUtils.getFiberNumWavelengthsVector(NetPlan netPlan,
                            long layerId)
Returns the total number of wavelengths in each fiber, where item 0 corresponds 
 to first fiber in the network, item 1 to the second one, and so on. 
 | 
static Map<Long,Set<Integer>> | 
WDMUtils.getFiberWavelengthOccupancyMap(NetPlan netPlan)
Returns the set of used wavelengths per fiber. 
 | 
static Map<Long,Set<Integer>> | 
WDMUtils.getFiberWavelengthOccupancyMap(NetPlan netPlan,
                              long layerId)
Returns the set of used wavelengths per fiber. 
 | 
static int[] | 
WDMUtils.getLightpathSeqRegenerators(NetPlan netPlan,
                           long lightpathId)
Returns the sequence of regenerators/wavelength converters for the given lightpath. 
 | 
static int[] | 
WDMUtils.getLightpathSeqRegenerators(NetPlan netPlan,
                           long layerId,
                           long lightpathId)
Returns the sequence of regenerators/wavelength converters for the given lightpath. 
 | 
static int[] | 
WDMUtils.getLightpathSeqWavelengths(NetPlan netPlan,
                          long lightpathId)
Returns the sequence of wavelengths for the given lightpath. 
 | 
static int[] | 
WDMUtils.getLightpathSeqWavelengths(NetPlan netPlan,
                          long layerId,
                          long lightpathId)
Returns the sequence of wavelengths for the given lightpath. 
 | 
static double | 
IPUtils.getLinkWeight(NetPlan netPlan,
             long linkId)
Returns the weight associated to a given link. 
 | 
static double | 
IPUtils.getLinkWeight(NetPlan netPlan,
             long layerId,
             long linkId)
Returns the weight associated to a given link. 
 | 
static Map<Long,Double> | 
IPUtils.getLinkWeightMap(NetPlan netPlan)
Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design. 
 | 
static Map<Long,Double> | 
IPUtils.getLinkWeightMap(NetPlan netPlan,
                long layerId)
Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design. 
 | 
static double[] | 
IPUtils.getLinkWeightVector(NetPlan netPlan)
Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design. 
 | 
static double[] | 
IPUtils.getLinkWeightVector(NetPlan netPlan,
                   long layerId)
Obtains the set of link weights (link attribute 'linkWeight', default: 1) from a given a network design. 
 | 
static Map<Long,Integer> | 
WDMUtils.getNodeRegeneratorOccupancyMap(NetPlan netPlan)
Returns the number of regenerators installed per node. 
 | 
static Map<Long,Integer> | 
WDMUtils.getNodeRegeneratorOccupancyMap(NetPlan netPlan,
                              long layerId)
Returns the number of regenerators installed per node. 
 | 
static double | 
TrafficComputationEngine.getPathBottleneckCapacity(NetPlan netPlan,
                         List<Long> path)
Returns the bottleneck (lowest) capacity among the set of traversed links and protection 
 segments. 
 | 
static double | 
TrafficComputationEngine.getPathBottleneckCapacity(NetPlan netPlan,
                         long layerId,
                         List<Long> path)
Returns the bottleneck (lowest) capacity among the set of traversed links and protection 
 segments. 
 | 
static int[] | 
WDMUtils.getProtectionLightpathSeqRegenerators(NetPlan netPlan,
                                     long protectionLightpathId)
Returns the sequence of regenerators/wavelength converters for the given lightpath. 
 | 
static int[] | 
WDMUtils.getProtectionLightpathSeqRegenerators(NetPlan netPlan,
                                     long layerId,
                                     long protectionLightpathId)
Returns the sequence of regenerators/wavelength converters for the given lightpath. 
 | 
static int[] | 
WDMUtils.getProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                    long protectionLightpathId)
Returns the sequence of wavelengths for a given protection lightpath. 
 | 
static int[] | 
WDMUtils.getProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                    long layerId,
                                    long protectionLightpathId)
Returns the sequence of wavelengths for a given protection lightpath. 
 | 
static double | 
TrafficComputationEngine.getRouteAverageLength(NetPlan netPlan,
                     long layerId,
                     Map<Long,Double> linkCostMap)
Obtains the average route length among the current routes according to
 certain link cost metric. 
 | 
static double | 
TrafficComputationEngine.getRouteAverageLength(NetPlan netPlan,
                     Map<Long,Double> linkCostMap)
Obtains the average route length among the current routes according to
 certain link cost metric. 
 | 
static cern.colt.matrix.tdouble.DoubleMatrix2D | 
IPUtils.getRoutingTableMatrix(NetPlan netPlan)
Obtains a destination-based routing from a given network design. 
 | 
static Pair<Double,Double> | 
SRGUtils.getSRGDisjointnessPercentage(NetPlan netPlan)
Returns the percentage of SRG disjointness of traffic routes and
 protection segments. 
 | 
static Pair<Double,Double> | 
SRGUtils.getSRGDisjointnessPercentage(NetPlan netPlan,
                            long layerId)
Returns the percentage of SRG disjointness of traffic routes and
 protection segments. 
 | 
static String | 
SRGUtils.getSRGModel(NetPlan netPlan)
Indicates whether SRG definition follows one of the predefined models (per 
 node, per link...), or 'Mixed' otherwise (or 'None' if no SRGs are defined). 
 | 
static String | 
SRGUtils.getSRGModel(NetPlan netPlan,
           long layerId)
Indicates whether SRG definition follows one of the predefined models (per 
 node, per link...), or 'Mixed' otherwise (or 'None' if no SRGs are defined). 
 | 
static Triple<Double,Double,Double> | 
TrafficComputationEngine.getTrafficProtectionDegree(NetPlan netPlan)
Returns the statistics for protection degree carried traffic. 
 | 
static Triple<Double,Double,Double> | 
TrafficComputationEngine.getTrafficProtectionDegree(NetPlan netPlan,
                          long layerId)
Returns the statistics for protection degree carried traffic. 
 | 
static List<Set<Long>> | 
WDMUtils.getWavelengthFiberOccupancy(NetPlan netPlan)
Returns the set of fibers occupied in each wavelength. 
 | 
static List<Set<Long>> | 
WDMUtils.getWavelengthFiberOccupancy(NetPlan netPlan,
                           long layerId)
Returns the set of fibers occupied in each wavelength. 
 | 
static Map<Long,Double> | 
TrafficMatrixGenerationModels.normalizeTraffic_linkCapacity_xde(NetPlan netPlan,
                                 String solverName,
                                 String solverLibraryName)
Returns the maximum scaled version of the offered traffic vector that 
 can be carried by the network, provided that no link is oversubscribed. 
 | 
static Map<Long,Double> | 
TrafficMatrixGenerationModels.normalizeTraffic_networkCapacity(NetPlan netPlan,
                                String shortestPathType)
Returns the maximum scaled version of the offered traffic vector so 
 that the network capacity (summation of capacity of all links) is exhausted. 
 | 
static void | 
IPUtils.setECMPForwardingRulesFromLinkWeights(NetPlan netPlan,
                                     long layerId,
                                     Map<Long,Double> linkWeightMap)
Sets the OSPF/ECMP forwarding rules in the given design, according to the 
 given IGP weight setting. 
 | 
static void | 
IPUtils.setECMPForwardingRulesFromLinkWeights(NetPlan netPlan,
                                     Map<Long,Double> linkWeightMap)
Sets the OSPF/ECMP forwarding rules in the given design, according to the 
 given IGP weight setting. 
 | 
static void | 
IPUtils.setECMPRoutesFromLinkWeights(NetPlan netPlan,
                            long layerId,
                            Map<Long,Double> linkWeightMap)
Sets the explicit traffic routing according to an OSPF/ECMP scheme. 
 | 
static void | 
IPUtils.setECMPRoutesFromLinkWeights(NetPlan netPlan,
                            Map<Long,Double> linkWeightMap)
Sets the explicit traffic routing according to an OSPF/ECMP scheme. 
 | 
static void | 
WDMUtils.setFiberNumWavelengths(NetPlan netPlan,
                      long fiberId,
                      int numWavelengths)
Sets the number of wavelengths available on the given fiber. 
 | 
static void | 
WDMUtils.setFiberNumWavelengths(NetPlan netPlan,
                      long layerId,
                      long fiberId,
                      int numWavelengths)
Sets the number of wavelengths available on the given fiber. 
 | 
static void | 
WDMUtils.setFibersNumWavelengths(NetPlan netPlan,
                       int numWavelengths)
Sets the number of wavelengths available in each fiber to the same value. 
 | 
static void | 
WDMUtils.setFibersNumWavelengths(NetPlan netPlan,
                       int[] w_f)
Sets the number of wavelengths available in each fiber. 
 | 
static void | 
WDMUtils.setFibersNumWavelengths(NetPlan netPlan,
                       long layerId,
                       int numWavelengths)
Sets the number of wavelengths available in each fiber to the same value. 
 | 
static void | 
WDMUtils.setFibersNumWavelengths(NetPlan netPlan,
                       long layerId,
                       int[] w_f)
Sets the number of wavelengths available in each fiber. 
 | 
static void | 
WDMUtils.setFibersNumWavelengths(NetPlan netPlan,
                       long layerId,
                       Map<Long,Integer> w_f)
Sets the number of wavelengths available in each fiber. 
 | 
static void | 
WDMUtils.setFibersNumWavelengths(NetPlan netPlan,
                       Map<Long,Integer> w_f)
Sets the number of wavelengths available in each fiber. 
 | 
static void | 
WDMUtils.setLightpathSeqRegenerators(NetPlan netPlan,
                           long lpId,
                           int[] seqRegenerators)
Sets the sequence of regenerators/wavelength converters for a given lightpath. 
 | 
static void | 
WDMUtils.setLightpathSeqRegenerators(NetPlan netPlan,
                           long layerId,
                           long lpId,
                           int[] seqRegenerators)
Sets the sequence of regenerators/wavelength converters for a given lightpath. 
 | 
static void | 
WDMUtils.setLightpathSeqWavelengths(NetPlan netPlan,
                          long lpId,
                          int wavelengthId)
Sets the current wavelength for the given lightpath, assuming no wavelength conversion. 
 | 
static void | 
WDMUtils.setLightpathSeqWavelengths(NetPlan netPlan,
                          long lpId,
                          int[] seqWavelengths)
Sets the sequence of wavelengths for the given lightpath. 
 | 
static void | 
WDMUtils.setLightpathSeqWavelengths(NetPlan netPlan,
                          long layerId,
                          long lpId,
                          int wavelengthId)
Sets the current wavelength for the given lightpath, assuming no wavelength conversion. 
 | 
static void | 
WDMUtils.setLightpathSeqWavelengths(NetPlan netPlan,
                          long layerId,
                          long lpId,
                          int[] seqWavelengths)
Sets the sequence of wavelengths for the given lightpath. 
 | 
static void | 
IPUtils.setLinkWeight(NetPlan netPlan,
             long linkId,
             double linkWeight)
Sets the weight associated to the link. 
 | 
static void | 
IPUtils.setLinkWeight(NetPlan netPlan,
             long layerId,
             long linkId,
             double linkWeight)
Sets the weight associated to the link. 
 | 
static void | 
IPUtils.setLinkWeights(NetPlan netPlan,
              double linkWeight)
Sets the weight associated to every link. 
 | 
static void | 
IPUtils.setLinkWeights(NetPlan netPlan,
              double[] linkWeightVector)
Sets the weight associated to each link. 
 | 
static void | 
IPUtils.setLinkWeights(NetPlan netPlan,
              long layerId,
              double linkWeight)
Sets the weight associated to every link. 
 | 
static void | 
IPUtils.setLinkWeights(NetPlan netPlan,
              long layerId,
              double[] linkWeightVector)
Sets the weight associated to each link. 
 | 
static void | 
IPUtils.setLinkWeights(NetPlan netPlan,
              long layerId,
              Map<Long,Double> linkWeightMap)
Sets the weight associated to each link. 
 | 
static void | 
IPUtils.setLinkWeights(NetPlan netPlan,
              Map<Long,Double> linkWeightMap)
Sets the weight associated to each link. 
 | 
static void | 
WDMUtils.setProtectionLightpathSeqRegenerators(NetPlan netPlan,
                                     long protectionLightpathId,
                                     int[] seqRegenerators)
Sets the sequence of regenerators/wavelength converters for a given protection lightpath. 
 | 
static void | 
WDMUtils.setProtectionLightpathSeqRegenerators(NetPlan netPlan,
                                     long layerId,
                                     long protectionLightpathId,
                                     int[] seqRegenerators)
Sets the sequence of regenerators/wavelength converters for a given protection lightpath. 
 | 
static void | 
WDMUtils.setProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                    long protectionLightpathId,
                                    int wavelengthId)
Sets the sequence of wavelengths for a protection lightpath, assuming no wavelength conversion. 
 | 
static void | 
WDMUtils.setProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                    long protectionLightpathId,
                                    int[] seqWavelengths)
Sets the sequence of wavelengths for a protection lightpath. 
 | 
static void | 
WDMUtils.setProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                    long layerId,
                                    long protectionLightpathId,
                                    int wavelengthId)
Sets the sequence of wavelengths for a protection lightpath, assuming no wavelength conversion. 
 | 
static void | 
WDMUtils.setProtectionLightpathSeqWavelengths(NetPlan netPlan,
                                    long layerId,
                                    long protectionLightpathId,
                                    int[] seqWavelengths)
Sets the sequence of wavelengths for a protection lightpath. 
 | 
| Constructor and Description | 
|---|
CandidatePathList(NetPlan netPlan,
                 long layerId,
                 Map<Long,Double> linkWeightMap,
                 String... paramValuePairs)
Initializes the candidate path list, computing all the paths for each
 demand. 
 | 
CandidatePathList(NetPlan netPlan,
                 long layerId,
                 String... paramValuePairs)
Initializes the candidate path list, computing all the paths for each
 demand. 
 | 
CandidatePathList(NetPlan netPlan,
                 Map<Long,Double> linkWeightMap,
                 String... paramValuePairs)
Initializes the candidate path list, computing all the paths for each
 demand. 
 | 
CandidatePathList(NetPlan netPlan,
                 String... paramValuePairs)
Initializes the candidate path list, computing all the paths for each
 demand. 
 |