$darkmode
|
DENOPTIM
|
Parameters controlling execution of GraphEditor. More...
Public Member Functions | |
| GraphListsHandlerParameters () | |
| Constructor. More... | |
| String | getOutFile () |
| FileFormat | getOutFormat () |
| void | interpretKeyword (String key, String value) throws DENOPTIMException |
| Processes a keyword/value pair and assign the related parameters. More... | |
| String | getPrintedList () |
| Returns the list of parameters in a string with newline characters as delimiters. More... | |
| void | checkParameters () throws DENOPTIMException |
| Evaluate consistency of input parameters. More... | |
| void | processParameters () throws DENOPTIMException |
| Processes all parameters and initialize related objects. More... | |
Public Member Functions inherited from denoptim.programs.RunTimeParameters | |
| RunTimeParameters (ParametersType paramType) | |
| Constructor. More... | |
| String | paramTypeName () |
| Returns a string defining the type the parameters collected here. More... | |
| String | getWorkDirectory () |
| Gets the pathname to the working directory. More... | |
| void | setWorkDirectory (String pathname) |
| Gets the pathname to the working directory. More... | |
| String | getLogFilePathname () |
| Gets the pathname to the log file. More... | |
| void | setLogFilePathname (String pathname) |
| Sets the pathname to the log file. More... | |
| Logger | getLogger () |
| Get the name of the program specific logger. More... | |
| Logger | startProgramSpecificLogger (String loggerIdentifier) throws SecurityException, IOException |
| Starts a logger with the given name. More... | |
| Logger | startProgramSpecificLogger (String loggerIdentifier, boolean toLogFile) throws SecurityException, IOException |
| Starts a logger with the given name. More... | |
| Logger | startConsoleLogger (String loggerIdentifier) |
| Starts a program-specific logger that prints to System.err stream. More... | |
| int | getVerbosity () |
| Returns the level of verbosity, i.e., the amount of log that we want to print. More... | |
| void | setVerbosity (int l) |
| Set the level of verbosity. More... | |
| Randomizer | getRandomizer () |
| Returns the current program-specific randomizer. More... | |
| long | getRandomSeed () |
| Returns the seed. More... | |
| void | setRandomizer (Randomizer rng) |
| Sets the randomizer. More... | |
| Randomizer | startRandomizer () |
| Starts a program specific randomizer, i.e., a tool for generating random numbers and taking random decisions. More... | |
| Randomizer | startRandomizer (long seed) |
| Starts a program specific randomizer, i.e., a tool for generating random numbers and taking random decisions. More... | |
| void | readParameterFile (String infile) throws DENOPTIMException |
| Read the parameter TXT file line by line and interpret its content. More... | |
| void | readParameterLine (String line) throws DENOPTIMException |
| boolean | containsParameters (ParametersType type) |
| RunTimeParameters | getParameters (ParametersType type) |
| void | setParameters (RunTimeParameters otherParams) |
| void | interpretKeyword (String line) throws DENOPTIMException |
| Processes a string looking for keyword and a possibly associated value. More... | |
| abstract void | interpretKeyword (String key, String value) throws DENOPTIMException |
| Processes a keyword/value pair and assign the related parameters. More... | |
| abstract void | checkParameters () throws DENOPTIMException |
| Evaluate consistency of input parameters. More... | |
| abstract void | processParameters () throws DENOPTIMException |
| Processes all parameters and initialize related objects. More... | |
| abstract String | getPrintedList () |
| Returns the list of parameters in a string with newline characters as delimiters. More... | |
| void | printParameters () |
| Print all parameters. More... | |
Protected Attributes | |
| ArrayList< DGraph > | inGraphsA |
| Input graphs: first list. More... | |
| ArrayList< DGraph > | inGraphsB |
| Input graphs: second list. More... | |
Protected Attributes inherited from denoptim.programs.RunTimeParameters | |
| boolean | isMaster = true |
| Flag signaling this is the master collection of parameters. More... | |
| String | workDir = System.getProperty("user.dir") |
| Working directory. More... | |
| String | logFile = "unset" |
| Log file. More... | |
| int | verbosity = 0 |
| Verbosity level for logger. More... | |
| Map< ParametersType, RunTimeParameters > | otherParameters |
| Collection of other parameters by type. More... | |
Private Attributes | |
| String | inGraphsFileA = null |
| File with input graphs. More... | |
| String | inGraphsFileB = null |
| String | outGraphsFile = null |
| File with output graphs. More... | |
| FileFormat | outGraphsFormat = FileFormat.GRAPHSDF |
Additional Inherited Members | |
Static Public Member Functions inherited from denoptim.programs.RunTimeParameters | |
| static boolean | readYesNoTrueFalse (String s) |
| Reads a string searching for any common way to say either yes/true (including shorthand t/y) or no/false (including shorthand f/n either). More... | |
Public Attributes inherited from denoptim.programs.RunTimeParameters | |
| final String | NL = System.getProperty("line.separator") |
| New line character. More... | |
Protected Member Functions inherited from denoptim.programs.RunTimeParameters | |
| void | checkOtherParameters () throws DENOPTIMException |
| Checks any of the parameter collections contained in this instance. More... | |
| void | processOtherParameters () throws DENOPTIMException |
| Processes any of the parameter collections contained in this instance. More... | |
| void | ensureFileExistsIfSet (String pathname) |
| Ensures a pathname is not empty nor null and that it does lead to an existing file or triggers an error. More... | |
| void | ensureFileExists (String pathname) |
| Ensures a pathname does lead to an existing file or triggers an error. More... | |
| void | ensureNotNull (String paramName, String param, String paramKey) |
| Ensures that a parameter is not null or triggers an error. More... | |
| void | ensureIsPositive (String paramName, int value, String paramKey) |
| Ensures that a parameter is a positive number (x>=0) or triggers an error. More... | |
| void | ensureIsPositiveOrZero (String paramName, int value, String paramKey) |
| Ensures that a parameter is a positive number (x>=0) or triggers an error. More... | |
| void | ensureInRange (String paramName, int value, int min, int max, String paramKey) |
| Ensures that a parameter is within a range or triggers an error. More... | |
Parameters controlling execution of GraphEditor.
Definition at line 39 of file GraphListsHandlerParameters.java.
| denoptim.programs.graphlisthandler.GraphListsHandlerParameters.GraphListsHandlerParameters | ( | ) |
Constructor.
Definition at line 70 of file GraphListsHandlerParameters.java.
References denoptim.programs.RunTimeParameters.ParametersType.GLH_PARAMS.
| void denoptim.programs.graphlisthandler.GraphListsHandlerParameters.checkParameters | ( | ) | throws DENOPTIMException |
Evaluate consistency of input parameters.
| DENOPTIMException |
Reimplemented from denoptim.programs.RunTimeParameters.
Definition at line 180 of file GraphListsHandlerParameters.java.
References denoptim.files.FileUtils.checkExists(), denoptim.programs.RunTimeParameters.checkOtherParameters(), denoptim.programs.graphlisthandler.GraphListsHandlerParameters.inGraphsFileA, denoptim.programs.graphlisthandler.GraphListsHandlerParameters.inGraphsFileB, denoptim.programs.graphlisthandler.GraphListsHandlerParameters.outGraphsFile, and denoptim.programs.RunTimeParameters.workDir.
Referenced by denoptim.programs.graphlisthandler.GraphListsHandler.runProgram().
| String denoptim.programs.graphlisthandler.GraphListsHandlerParameters.getOutFile | ( | ) |
Definition at line 77 of file GraphListsHandlerParameters.java.
References denoptim.programs.graphlisthandler.GraphListsHandlerParameters.outGraphsFile.
| FileFormat denoptim.programs.graphlisthandler.GraphListsHandlerParameters.getOutFormat | ( | ) |
Definition at line 84 of file GraphListsHandlerParameters.java.
References denoptim.programs.graphlisthandler.GraphListsHandlerParameters.outGraphsFormat.
| String denoptim.programs.graphlisthandler.GraphListsHandlerParameters.getPrintedList | ( | ) |
Returns the list of parameters in a string with newline characters as delimiters.
Reimplemented from denoptim.programs.RunTimeParameters.
Definition at line 148 of file GraphListsHandlerParameters.java.
References denoptim.programs.RunTimeParameters.NL, denoptim.programs.RunTimeParameters.otherParameters, and denoptim.programs.RunTimeParameters.paramTypeName().
| void denoptim.programs.graphlisthandler.GraphListsHandlerParameters.interpretKeyword | ( | String | key, |
| String | value | ||
| ) | throws DENOPTIMException |
Processes a keyword/value pair and assign the related parameters.
| key | the keyword as string |
| value | the value as a string |
| DENOPTIMException |
Reimplemented from denoptim.programs.RunTimeParameters.
Definition at line 98 of file GraphListsHandlerParameters.java.
References denoptim.programs.graphlisthandler.GraphListsHandlerParameters.inGraphsFileA, denoptim.programs.graphlisthandler.GraphListsHandlerParameters.inGraphsFileB, denoptim.programs.RunTimeParameters.logFile, denoptim.programs.graphlisthandler.GraphListsHandlerParameters.outGraphsFile, denoptim.programs.graphlisthandler.GraphListsHandlerParameters.outGraphsFormat, denoptim.programs.RunTimeParameters.verbosity, and denoptim.programs.RunTimeParameters.workDir.
| void denoptim.programs.graphlisthandler.GraphListsHandlerParameters.processParameters | ( | ) | throws DENOPTIMException |
Processes all parameters and initialize related objects.
| DENOPTIMException |
Reimplemented from denoptim.programs.RunTimeParameters.
Definition at line 223 of file GraphListsHandlerParameters.java.
References denoptim.files.FileUtils.checkExists(), denoptim.programs.graphlisthandler.GraphListsHandlerParameters.inGraphsA, denoptim.programs.graphlisthandler.GraphListsHandlerParameters.inGraphsB, denoptim.programs.graphlisthandler.GraphListsHandlerParameters.inGraphsFileA, denoptim.programs.graphlisthandler.GraphListsHandlerParameters.inGraphsFileB, denoptim.programs.graphlisthandler.GraphListsHandlerParameters.outGraphsFile, denoptim.programs.RunTimeParameters.processOtherParameters(), and denoptim.io.DenoptimIO.readDENOPTIMGraphsFromFile().
Referenced by denoptim.programs.graphlisthandler.GraphListsHandler.runProgram().
|
protected |
Input graphs: first list.
Definition at line 50 of file GraphListsHandlerParameters.java.
Referenced by denoptim.programs.graphlisthandler.GraphListsHandlerParameters.processParameters(), and denoptim.programs.graphlisthandler.GraphListsHandler.runProgram().
|
protected |
Input graphs: second list.
Definition at line 56 of file GraphListsHandlerParameters.java.
Referenced by denoptim.programs.graphlisthandler.GraphListsHandlerParameters.processParameters(), and denoptim.programs.graphlisthandler.GraphListsHandler.runProgram().
|
private |
File with input graphs.
Definition at line 44 of file GraphListsHandlerParameters.java.
Referenced by denoptim.programs.graphlisthandler.GraphListsHandlerParameters.checkParameters(), denoptim.programs.graphlisthandler.GraphListsHandlerParameters.interpretKeyword(), and denoptim.programs.graphlisthandler.GraphListsHandlerParameters.processParameters().
|
private |
Definition at line 45 of file GraphListsHandlerParameters.java.
Referenced by denoptim.programs.graphlisthandler.GraphListsHandlerParameters.checkParameters(), denoptim.programs.graphlisthandler.GraphListsHandlerParameters.interpretKeyword(), and denoptim.programs.graphlisthandler.GraphListsHandlerParameters.processParameters().
|
private |
File with output graphs.
Definition at line 62 of file GraphListsHandlerParameters.java.
Referenced by denoptim.programs.graphlisthandler.GraphListsHandlerParameters.checkParameters(), denoptim.programs.graphlisthandler.GraphListsHandlerParameters.getOutFile(), denoptim.programs.graphlisthandler.GraphListsHandlerParameters.interpretKeyword(), and denoptim.programs.graphlisthandler.GraphListsHandlerParameters.processParameters().
|
private |
Definition at line 63 of file GraphListsHandlerParameters.java.
Referenced by denoptim.programs.graphlisthandler.GraphListsHandlerParameters.getOutFormat(), and denoptim.programs.graphlisthandler.GraphListsHandlerParameters.interpretKeyword().