com.net2plan.interfaces.networkDesign

Class Configuration

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. Default: workspace\BuiltInExamples.jar file
• 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.

Since:

0.2.0

Author:

Pablo Pavon-Marino, Jose-Luis Izquierdo-Zaragoza

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Methods

Modifier and Type	Method and Description
static void	check(Map<String,String> net2planParameters) Checks the given options for validity.
static String	getOption(String option) Returns the value of an option.
static Map<String,String>	getOptions() Returns the current map of options.
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	setOption(String option, String value) Puts the value for an option.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Configuration

public Configuration()

Method Detail

check

public static void check(Map<String,String> net2planParameters)

Checks the given options for validity.

Parameters:

net2planParameters - A key-value map with Net2Plan-wide configuration options

Since:

0.2.2

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 Map<String,String> getOptions()

Returns the current map of options.

Returns:

Map 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

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