Configuration (net2plan-javadoc 0.6.0.1 API)

java.lang.Object
- com.net2plan.interfaces.networkDesign.Configuration

```
public class Configuration
extends Object
```
Class containing current Net2Plan-wide options, and methods to work with them.

In the current version the available options are:
- classpath (String): Set of external libraries loaded at runtime (separated by semi-colon). Default: None
- defaultRunnableCodePath (String): Default path (either .jar file or folder) for external code (i.e. algorithms). Default: workspace\BuiltInExamples.jar file
- topologyViewer (String): Type of topology viewer. Default: JUNGCanvas
- precisionFactor (double): Precision factor for checks to overcome numeric errors. Default: 1e-3
In addition, due to the close relation to JOM library, some JOM-specific options can be configured:
- defaultILPSolver (String): Default solver for LP/ILP models. Default: glpk
- defaultNLPSolver (String): Default solver for NLP models. Default: ipopt
- cplexSolverLibraryName (String): Default path for cplex library (.dll/.so/.dylib file). Default: None
- glpkSolverLibraryName (String): Default path for glpk library (.dll/.so/.dylib file). Default: None
- ipoptSolverLibraryName (String): Default path for ipopt library (.dll/.so/.dylib file). Default: None
Important: Values are stored in String format. Users are responsible to make conversions to the appropiate type (i.e. double).

Important: Users should not access this class directly. All interfaces for implementing user-made code (i.e. algorithms) include a map so-called net2planParameters as input parameter, where users can find the current configuration of the tool (e.g. IAlgorithm.executeAlgorithm()) .
Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Field Summary

Fields
Modifier and Type Field and Description

static double precisionFactor

Fields
Modifier and Type	Field and Description
`static double`	`precisionFactor`

Constructor Summary

Constructors
Constructor and Description

Configuration()

Constructors
Constructor and Description
`Configuration()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`check(SortedMap<String,String> net2planParameters)` Checks the given options for validity.
`static String`	`getDefaultIlpSolverName()` Returns the default solver defined for ILP programs
`static String`	`getDefaultSolverLibraryName(String solver)` Returns the default name of the library file (to set as solverLibraryName in JOM calls), defined by the user for the given solver name.
`static SortedMap<String,String>`	`getNet2PlanOptions()` Returns the current map of Net2Plan-wide options.
`static List<Triple<String,String,String>>`	`getNet2PlanParameters()` Returns the list of Net2Plan-wide parameters, where the first item of each element is the parameter name, the second one is the parameter value, and the third one is the parameter description.
`static String`	`getOption(String option)` Returns the value of an option.
`static SortedMap<String,String>`	`getOptions()` Returns the current map of options (inlcuding ones those from plugins).
`static void`	`readFromOptionsDefaultFile()` Reads options from the default file.
`static void`	`readFromOptionsFile(File f)` Reads options from a given file.
`static void`	`saveOptions()` Saves current options to the file system.
`static void`	`setDefaultSolverLibraryName(String solver, String name)` Sets the default name of the library file (to set as solverLibraryName in JOM calls).
`static void`	`setOption(String option, String value)` Puts the value for an option.
`static void`	`setOptions(Map<String,String> options)` Puts the value a set of options.
`static void`	`updateSolverLibraryNameParameter(Map<String,String> parameters)` Goes through this map of parameters and, if both the parameters solverName and solverLibraryName exist, and solverLibraryName equals "", then sets the value of such parameter to the default library file set by the user (in user->options) for such solver.

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

- Field Detail
  - precisionFactor
```
public static double precisionFactor
```
- Constructor Detail
  - Configuration
```
public Configuration()
```
- Method Detail
  - check
```
public static void check(SortedMap<String,String> net2planParameters)
```
    Checks the given options for validity.
    
    Parameters:
    
    net2planParameters - A key-value map with Net2Plan-wide configuration options
    
    Since:
    
    0.2.2
  - getDefaultIlpSolverName
```
public static String getDefaultIlpSolverName()
```
    Returns the default solver defined for ILP programs
    
    Returns:
    
    see above
  - getDefaultSolverLibraryName
```
public static String getDefaultSolverLibraryName(String solver)
```
    Returns the default name of the library file (to set as solverLibraryName in JOM calls), defined by the user for the given solver name. In the XPRESS solver case, this corresponds to the credentials for the license (xpauth.xpr file typically). Throws an Exception if the solver name matches any of the accepted by JOM
    
    Parameters:
    
    solver - The name of the solver (case insensitive)
    
    Returns:
    
    The file name as defined by the user in the Net2Plan options for the
  - getNet2PlanOptions
```
public static SortedMap<String,String> getNet2PlanOptions()
```
    Returns the current map of Net2Plan-wide options.
    
    Returns:
    
    SortedMap of current options
    
    Since:
    
    0.3.0
  - getNet2PlanParameters
```
public static List<Triple<String,String,String>> getNet2PlanParameters()
```
    Returns the list of Net2Plan-wide parameters, where the first item of each element is the parameter name, the second one is the parameter value, and the third one is the parameter description.
    
    It is possible to define type-specific parameters if the default value is set according to the following rules (but user is responsible of checking in its own code):
    - If the default value is #select# and a set of space- or comma-separated values, the GUI will show a combobox with all the values, where the first one will be the selected one by default. For example: "#select# hops km" will allow choosing in the GUI between hops and km, where hops will be the default value.
    - If the default value is #boolean# and true or false, the GUI will show a checkbox, where the default value will be true or false, depending on the value accompanying to #boolean#. For example: "#boolean# true" will show a checkbox marked by default.
    - If the default value is #algorithm#, the GUI will prepare a new interface to select an algorithm as parameter. Three new fields will be added, including "_file", "_classname" and "_parameters" suffixes to the indicated parameter name, refer to the .class or .jar file where the code is located, the class name, and a set of parameters (pair of key-values separated by commas, where individual key and value are separated with an equal symbol. The same applies to reports (#report#), event generators (#eventGenerator#) and event processors (#eventProcessor#).
    Returns:
    
    List of specific Net2Plan-wide parameters
    
    Since:
    
    0.3.0
  - getOption
```
public static String getOption(String option)
```
    Returns the value of an option.
    
    Parameters:
    
    option - Option name
    
    Returns:
    
    Option value
    
    Since:
    
    0.2.0
  - getOptions
```
public static SortedMap<String,String> getOptions()
```
    Returns the current map of options (inlcuding ones those from plugins).
    
    Returns:
    
    SortedMap of current options
    
    Since:
    
    0.2.0
  - readFromOptionsDefaultFile
```
public static void readFromOptionsDefaultFile()
                                       throws IOException
```
    Reads options from the default file.
    
    Throws:
    
    IOException - If the specified file cannot be loaded
    
    Since:
    
    0.2.0
  - readFromOptionsFile
```
public static void readFromOptionsFile(File f)
                                throws IOException
```
    Reads options from a given file.
    
    Parameters:
    
    f - Options file
    
    Throws:
    
    IOException - If the specified file cannot be loaded
    
    Since:
    
    0.2.0
  - saveOptions
```
public static void saveOptions()
```
    Saves current options to the file system.
    
    Since:
    
    0.2.0
  - setDefaultSolverLibraryName
```
public static void setDefaultSolverLibraryName(String solver,
                                               String name)
```
    Sets the default name of the library file (to set as solverLibraryName in JOM calls).
    
    Parameters:
    
    solver - Name of the solver
    
    name - The file name that will be defined at the Net2Plan options.
  - setOption
```
public static void setOption(String option,
                             String value)
```
    Puts the value for an option. If an option already exists, its value will be overriden.
    
    Parameters:
    
    option - Option name
    
    value - Option value
    
    Since:
    
    0.2.0
  - setOptions
```
public static void setOptions(Map<String,String> options)
```
    Puts the value a set of options. If an option already exists, its value will be overriden.
    
    Parameters:
    
    options - Option name and value pairs
    
    Since:
    
    0.3.0
  - updateSolverLibraryNameParameter
```
public static void updateSolverLibraryNameParameter(Map<String,String> parameters)
```
    Goes through this map of parameters and, if both the parameters solverName and solverLibraryName exist, and solverLibraryName equals "", then sets the value of such parameter to the default library file set by the user (in user->options) for such solver.
    
    Parameters:
    
    parameters - The map of parameters, that may be modified in the solverLibraryName key

Class Configuration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

precisionFactor

Constructor Detail

Configuration

Method Detail

check

getDefaultIlpSolverName

getDefaultSolverLibraryName

getNet2PlanOptions

getNet2PlanParameters

getOption

getOptions

readFromOptionsDefaultFile

readFromOptionsFile

saveOptions

setDefaultSolverLibraryName

setOption

setOptions

updateSolverLibraryNameParameter