Run parameters for GAMSEngineJob. More...
Classes | |
class | newBuilder |
A builder of GAMSEngineRunParameters. More... | |
Public Member Functions | |
boolean | removeResults () |
Gets flag that determines if the job results on the engine server should be removed. | |
GAMSEngineConfiguration | configuration () |
Gets GAMSEngineConfiguration. | |
Set< String > | extraModelFiles () |
Gets a set of extra model files. | |
Map< String, String > | engineOptions () |
Gets a map of engine options. | |
void | setRemoveResults (boolean b) |
Sets flag that determines if the job results should be removed as a run parameter. | |
void | setRunEngineConfiguration (GAMSEngineConfiguration c) |
Sets GAMSEngineConfiguration as a run parameter. | |
void | setExtraModelFiles (Set< String > modelFiles) |
Sets a set of extra model files as run parameter. | |
void | setEngineOptions (Map< String, String > options) |
Sets a map of engine options as a run parameter. | |
Public Member Functions inherited from com.gams.api.AbstractRunParameters | |
GAMSOptions | options () |
Gets GAMSOptions. | |
GAMSCheckpoint | checkpoint () |
Gets GAMSCheckpoint. | |
PrintStream | output () |
Gets output stream. | |
boolean | createOutDB () |
Gets flag that determines if an output database should be created | |
List< GAMSDatabase > | databases () |
Gets list of GAMSDatabases | |
void | setGAMSOptions (GAMSOptions option) |
Sets GAMSOptions as a run parameter. | |
void | setGAMSCheckpoint (GAMSCheckpoint checkpoint) |
Sets GAMSCheckpoint as a run parameter. | |
void | setOutput (PrintStream out) |
Sets Output stream as a run parameter. | |
void | setCreateOutDB (boolean b) |
Sets flag that determines if an output database should be created as a run parameter. | |
void | setGAMSDatabases (List< GAMSDatabase > db) |
Sets list of GAMSDatabases as a run parameter. | |
Detailed Description
Run parameters for GAMSEngineJob.
GAMSEngineRunParameters instance is created through a GAMSEngineRunParameters.newBuilder() constructor.
An instance of GAMSEngineRunParameters can be created through GAMSEngineRunParameters.newBuilder instance. A GAMSEngineRunParameters.newBuilder instance is created by calling GAMSEngineRunParameters.newBuilder() constructor and an instance of GAMSEngineRunParameters is obtained from the build() method of a GAMSEngineRunParameters.newBuilder instance.
GAMSEngineRunParameters.newBuilder instance can be copied and modified multiple times in order to build multiple GAMSEngineRunParameters instances with different run parameters.
Member Function Documentation
◆ configuration()
GAMSEngineConfiguration com.gams.api.GAMSEngineRunParameters.configuration | ( | ) |
Gets GAMSEngineConfiguration.
◆ engineOptions()
Map< String, String > com.gams.api.GAMSEngineRunParameters.engineOptions | ( | ) |
Gets a map of engine options.
◆ extraModelFiles()
Set< String > com.gams.api.GAMSEngineRunParameters.extraModelFiles | ( | ) |
Gets a set of extra model files.
◆ removeResults()
boolean com.gams.api.GAMSEngineRunParameters.removeResults | ( | ) |
Gets flag that determines if the job results on the engine server should be removed.
The flag value is true by default, if not set otherwise.
- Returns
- boolean flag value
◆ setEngineOptions()
void com.gams.api.GAMSEngineRunParameters.setEngineOptions | ( | Map< String, String > | options | ) |
Sets a map of engine options as a run parameter.
◆ setExtraModelFiles()
void com.gams.api.GAMSEngineRunParameters.setExtraModelFiles | ( | Set< String > | modelFiles | ) |
Sets a set of extra model files as run parameter.
◆ setRemoveResults()
void com.gams.api.GAMSEngineRunParameters.setRemoveResults | ( | boolean | b | ) |
Sets flag that determines if the job results should be removed as a run parameter.
◆ setRunEngineConfiguration()
void com.gams.api.GAMSEngineRunParameters.setRunEngineConfiguration | ( | GAMSEngineConfiguration | c | ) |
Sets GAMSEngineConfiguration as a run parameter.