GAMSEngineJob manages the execution of a GAMS program given by GAMS model source for GAMS Engine. More...
Classes | |
| class | newBuilder |
| A builder of GAMSEngineJob. More... | |
Public Member Functions | |
| String | jobName () |
| Gets the job name. | |
| String | workingDirectory () |
| Gets the working directory name. | |
| String | token () |
| Gets the job token string that is returned from successful job creation. | |
| GAMSEngineConfiguration | configuration () |
| Gets GAMSEngineConfiguration. | |
| boolean | removeResults () |
| Gets flag that determines if OutDB should be created | |
| Set< String > | extraModelFiles () |
| Gets the set of extra model files. | |
| Map< String, String > | engineOptions () |
| Gets the map of engine options. | |
| void | reset () |
| Removes all of the sets, mappings from this GAMSEngineJob and reset other instance variables of this GAMSEngineJob to null. | |
| int | run () |
| Runs GAMSEngineJob. | |
| boolean | interrupt () |
| Send interrupt message to GAMS during GAMSEngineJob instance executes its run method. | |
Detailed Description
GAMSEngineJob manages the execution of a GAMS program given by GAMS model source for GAMS Engine.
Member Function Documentation
◆ configuration()
| GAMSEngineConfiguration com.gams.api.GAMSEngineJob.configuration | ( | ) |
Gets GAMSEngineConfiguration.
◆ engineOptions()
| Map< String, String > com.gams.api.GAMSEngineJob.engineOptions | ( | ) |
Gets the map of engine options.
◆ extraModelFiles()
| Set< String > com.gams.api.GAMSEngineJob.extraModelFiles | ( | ) |
Gets the set of extra model files.
◆ interrupt()
| boolean com.gams.api.GAMSEngineJob.interrupt | ( | ) |
Send interrupt message to GAMS during GAMSEngineJob instance executes its run method.
This method is useful for interrupting the long running GAMSEngineJob.
- Exceptions
-
GAMSException If GAMSJob instance could not be successfully interrupted
- Returns
- true if GAMS has acknowledged an interrupt message, false otherwise.
◆ jobName()
| String com.gams.api.GAMSEngineJob.jobName | ( | ) |
Gets the job name.
◆ removeResults()
| boolean com.gams.api.GAMSEngineJob.removeResults | ( | ) |
Gets flag that determines if OutDB should be created
◆ reset()
| void com.gams.api.GAMSEngineJob.reset | ( | ) |
Removes all of the sets, mappings from this GAMSEngineJob and reset other instance variables of this GAMSEngineJob to null.
Though the underlying external resources of the instance variables, if there is any, will not be released.
◆ run()
| int com.gams.api.GAMSEngineJob.run | ( | ) |
Runs GAMSEngineJob.
- Exceptions
-
GAMSException If GAMSJob instance could not be successfully executed
◆ token()
| String com.gams.api.GAMSEngineJob.token | ( | ) |
Gets the job token string that is returned from successful job creation.
◆ workingDirectory()
| String com.gams.api.GAMSEngineJob.workingDirectory | ( | ) |
Gets the working directory name.