$darkmode
DENOPTIM
denoptim.programs.denovo.GARunner Class Reference

Programs that runs de novo design by a genetic algorithm. More...

Inheritance diagram for denoptim.programs.denovo.GARunner:
[legend]
Collaboration diagram for denoptim.programs.denovo.GARunner:
[legend]

Public Member Functions

 GARunner (File configFile, File workDir)
 Creates and configures the program task. More...
 
void runProgram () throws Throwable
 
- Public Member Functions inherited from denoptim.task.ProgramTask
 ProgramTask (File configFile, File workDir)
 Creates and configures the program task. More...
 
Object call ()
 This method redirects the callable functionality to an abstract method (namely ProgramTask#runProgram()) to be specified by the implementations of this abstract class. More...
 
void printErrorToFile ()
 Method that can be called to create a text file with the error triggered by any Throwable that can be thrown by the execution of the program. More...
 
- Public Member Functions inherited from denoptim.task.Task
 Task (final int id)
 
int getId ()
 
void setVerbosity (int verbosity)
 Set the verbosity: i.e., amount of log printed by this class. More...
 
void setWorkSpace (File workDir)
 Sets the pathname of the work space, i.e., the location where the task is supposed to use move to or to threat as the result of "pwd" at runtime. More...
 
boolean isCompleted ()
 
boolean foundException ()
 
Throwable getException ()
 
String getErrorMessage ()
 
void stopTask ()
 Stop the task if not already completed. More...
 
String toString ()
 Returns a string identifying this task by its ID and reporting whether an exception has been thrown and if the tasks is completed. More...
 
void setNotify (boolean notify)
 

Protected Member Functions

void handleThrowable ()
 Method to handle any Throwable originated from the runProgram() method. More...
 
- Protected Member Functions inherited from denoptim.task.ProgramTask
void handleThrowable ()
 Method to handle any Throwable originated from the runProgram() method. More...
 
void stopLogger ()
 Stops the program-specific logger and releases the lock file on the logfile. More...
 
abstract void runProgram () throws Throwable
 

Private Member Functions

void stopExternalCmdListener ()
 Stop the service that waits for instructions from the outside world. More...
 

Private Attributes

EvolutionaryAlgorithm ea = null
 The implementation of the evolutionary algorithm we run here. More...
 
ExternalCmdsListener ecl = null
 The service that listens for commands from outside the JVM. More...
 
ExecutorService executor = null
 Executor of the service that listens for commands. More...
 
Future<?> futureWatchers = null
 Pending tasks of the service listening for commands. More...
 

Additional Inherited Members

- Public Attributes inherited from denoptim.task.Task
Object lock = new Object()
 Lock for addressing synchronization issues. More...
 
- Protected Attributes inherited from denoptim.task.ProgramTask
File configFilePathName
 File containing configuration parameters for the program task. More...
 
String loggerIdentifier = "none"
 Identifier of this program's logger. More...
 
- Protected Attributes inherited from denoptim.task.Task
boolean notifyGlobalTaskManager = false
 Flag controlling whether this task is expected to notify the static task manager. More...
 
boolean completed = false
 Flag about completion. More...
 
boolean hasException = false
 Flag about exception. More...
 
String errMsg = ""
 Error message produced by any subtask. More...
 
Throwable thrownExc
 Exception thrown. More...
 
int id
 A user-assigned id for this task. More...
 
ProcessHandler processHandler
 Executor for external bash script. More...
 
File workDir
 The file system location where we want to be placed when doing the work. More...
 
int verbosity = 0
 Verbosity level. More...
 
final String SEP = System.getProperty("file.separator")
 System-dependent file separator. More...
 
final String NL = System.getProperty("line.separator")
 System-dependent line separator (newline) More...
 

Detailed Description

Programs that runs de novo design by a genetic algorithm.

Author
Vishwesh Venkatraman
Marco Foscato

Definition at line 39 of file GARunner.java.

Constructor & Destructor Documentation

◆ GARunner()

denoptim.programs.denovo.GARunner.GARunner ( File  configFile,
File  workDir 
)

Creates and configures the program task.

Parameters
configFilethe file containing the configuration parameters.
workDirthe file system location from which to run the program.

Definition at line 69 of file GARunner.java.

References denoptim.task.Task.workDir.

Member Function Documentation

◆ handleThrowable()

void denoptim.programs.denovo.GARunner.handleThrowable ( )
protected

Method to handle any Throwable originated from the runProgram() method.

This method can be overwritten to alter the behavior in case of specific needs.

Reimplemented from denoptim.task.ProgramTask.

Definition at line 106 of file GARunner.java.

References denoptim.programs.denovo.GARunner.ea, denoptim.programs.denovo.GARunner.stopExternalCmdListener(), and denoptim.ga.EvolutionaryAlgorithm.stopRun().

Here is the call graph for this function:

◆ runProgram()

◆ stopExternalCmdListener()

void denoptim.programs.denovo.GARunner.stopExternalCmdListener ( )
private

Stop the service that waits for instructions from the outside world.

Parameters
ecl
executor
futureWatchers

Definition at line 124 of file GARunner.java.

References denoptim.ga.ExternalCmdsListener.closeWatcher(), denoptim.programs.denovo.GARunner.ecl, denoptim.programs.denovo.GARunner.executor, and denoptim.programs.denovo.GARunner.futureWatchers.

Referenced by denoptim.programs.denovo.GARunner.handleThrowable(), and denoptim.programs.denovo.GARunner.runProgram().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ ea

EvolutionaryAlgorithm denoptim.programs.denovo.GARunner.ea = null
private

The implementation of the evolutionary algorithm we run here.

Definition at line 44 of file GARunner.java.

Referenced by denoptim.programs.denovo.GARunner.handleThrowable(), and denoptim.programs.denovo.GARunner.runProgram().

◆ ecl

ExternalCmdsListener denoptim.programs.denovo.GARunner.ecl = null
private

The service that listens for commands from outside the JVM.

Definition at line 49 of file GARunner.java.

Referenced by denoptim.programs.denovo.GARunner.runProgram(), and denoptim.programs.denovo.GARunner.stopExternalCmdListener().

◆ executor

ExecutorService denoptim.programs.denovo.GARunner.executor = null
private

Executor of the service that listens for commands.

Definition at line 54 of file GARunner.java.

Referenced by denoptim.programs.denovo.GARunner.runProgram(), and denoptim.programs.denovo.GARunner.stopExternalCmdListener().

◆ futureWatchers

Future<?> denoptim.programs.denovo.GARunner.futureWatchers = null
private

Pending tasks of the service listening for commands.

Definition at line 59 of file GARunner.java.

Referenced by denoptim.programs.denovo.GARunner.runProgram(), and denoptim.programs.denovo.GARunner.stopExternalCmdListener().


The documentation for this class was generated from the following file: