com.gams.api.AbstractRunParameters Class Referenceabstract
Abstract class for run parameters. More...
Inheritance diagram for com.gams.api.AbstractRunParameters:
Classes | |
class | newBuilder |
Abstract builder of AbstractRunParameters. More... | |
Public Member Functions | |
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
Abstract class for run parameters.
An instance of an AbstractRunParameters class can be used to store parameters for running a job, such as options, checkpoint, output log, flag to determine if output database should be created and a list of input databases.
Member Function Documentation
◆ checkpoint()
GAMSCheckpoint com.gams.api.AbstractRunParameters.checkpoint | ( | ) |
Gets GAMSCheckpoint.
◆ createOutDB()
boolean com.gams.api.AbstractRunParameters.createOutDB | ( | ) |
Gets flag that determines if an output database should be created
◆ databases()
List< GAMSDatabase > com.gams.api.AbstractRunParameters.databases | ( | ) |
Gets list of GAMSDatabases
◆ options()
GAMSOptions com.gams.api.AbstractRunParameters.options | ( | ) |
Gets GAMSOptions.
◆ output()
PrintStream com.gams.api.AbstractRunParameters.output | ( | ) |
Gets output stream.
◆ setCreateOutDB()
void com.gams.api.AbstractRunParameters.setCreateOutDB | ( | boolean | b | ) |
Sets flag that determines if an output database should be created as a run parameter.
◆ setGAMSCheckpoint()
void com.gams.api.AbstractRunParameters.setGAMSCheckpoint | ( | GAMSCheckpoint | checkpoint | ) |
Sets GAMSCheckpoint as a run parameter.
◆ setGAMSDatabases()
void com.gams.api.AbstractRunParameters.setGAMSDatabases | ( | List< GAMSDatabase > | db | ) |
Sets list of GAMSDatabases as a run parameter.
◆ setGAMSOptions()
void com.gams.api.AbstractRunParameters.setGAMSOptions | ( | GAMSOptions | option | ) |
Sets GAMSOptions as a run parameter.
◆ setOutput()
void com.gams.api.AbstractRunParameters.setOutput | ( | PrintStream | out | ) |
Sets Output stream as a run parameter.