Loading...
Searching...
No Matches
com.gams.api.GAMSEngineRunParameters.newBuilder Class Reference

A builder of GAMSEngineRunParameters. More...

Inheritance diagram for com.gams.api.GAMSEngineRunParameters.newBuilder:
com.gams.api.AbstractRunParameters.newBuilder< GAMSEngineRunParameters, GAMSEngineRunParameters.newBuilder >

Public Member Functions

newBuilder setRemoveResults (boolean removeResults)
 Sets flag that determines if the job results on the engine server should be removed after running a job.
 
newBuilder setExtraModelFiles (Set< String > modelFiles)
 Sets extra model files.
 
newBuilder setEngineOptions (HashMap< String, String > options)
 Sets engine options.
 
- Public Member Functions inherited from com.gams.api.AbstractRunParameters.newBuilder< GAMSEngineRunParameters, GAMSEngineRunParameters.newBuilder >
 newBuilder ()
 Creates a newBuilder instance.
 
build ()
 Abstract method to create and return an instance of AbstractRunParameters or one its subclasses.
 
setGAMSOptions (GAMSOptions option)
 Sets an instance of GAMSOptions as a run parameter.
 
setGAMSCheckpoint (GAMSCheckpoint checkpoint)
 Sets an instance of GAMSCheckpoint as a run parameter.
 
setOutput (PrintStream output)
 Sets an output Stream to capture GAMS log as a run parameter.
 
setCreateOutDB (boolean createOutDB)
 Sets a flag that determines if an output database should be created after running a job.
 
setDatabases (ArrayList< GAMSDatabase > db)
 Sets a lsit of GAMSDatabase as a run parameter.
 

Protected Member Functions

GAMSEngineRunParameters createObject ()
 Creates and returns an instance of GAMSEngineRunParameters.
 
newBuilder thisBuilder ()
 Gets the GAMSEngineRunParameters.newBuilder instance.
 
- Protected Member Functions inherited from com.gams.api.AbstractRunParameters.newBuilder< GAMSEngineRunParameters, GAMSEngineRunParameters.newBuilder >
abstract B thisBuilder ()
 Abstract method to get the instance of AbstractRunParameters subclass.
 
abstract T createObject ()
 Abstract method to create and return the instance of AbstractRunParameters subclass.
 

Detailed Description

A builder of GAMSEngineRunParameters.

Instances of GAMSEngineRunParameters.newBuilder are created by calling the constructor of GAMSEngineGAMSEngineRunParameters.newBuilder. An new instance of GAMSEngineGAMSEngineRunParameters is created by calling build() on a GAMSEngineGAMSEngineRunParameters.newBuilder instance.

Member Function Documentation

◆ createObject()

GAMSEngineRunParameters com.gams.api.GAMSEngineRunParameters.newBuilder.createObject ( )
protected

Creates and returns an instance of GAMSEngineRunParameters.

◆ setEngineOptions()

newBuilder com.gams.api.GAMSEngineRunParameters.newBuilder.setEngineOptions ( HashMap< String, String >  options)

Sets engine options.

Returns
the instance of GAMSEngineRunParameters.newBuilder.

◆ setExtraModelFiles()

newBuilder com.gams.api.GAMSEngineRunParameters.newBuilder.setExtraModelFiles ( Set< String >  modelFiles)

Sets extra model files.

Returns
the instance of GAMSEngineRunParameters.newBuilder.

◆ setRemoveResults()

newBuilder com.gams.api.GAMSEngineRunParameters.newBuilder.setRemoveResults ( boolean  removeResults)

Sets flag that determines if the job results on the engine server should be removed after running a job.

Returns
the instance of GAMSEngineRunParameters.newBuilder.

◆ thisBuilder()

newBuilder com.gams.api.GAMSEngineRunParameters.newBuilder.thisBuilder ( )
protected

Gets the GAMSEngineRunParameters.newBuilder instance.

Returns
the instance of GAMSEngineRunParameters.newBuilder.