Loading...
Searching...
No Matches
Matlab.GAMS.GAMSEngineJob Class Reference

Manages the execution of a GAMS program given by GAMS model source for GAMS Engine. More...

Public Member Functions

logical interrupt ()
 Send interrupt message to GAMS during GAMSEngineJob instance executes its run method.
 
void reset ()
 Removes all of the sets, mappings from this GAMSEngineJob and reset other instance variables.
 
integer run ()
 Runs Engine job.
 

Public Attributes

GAMSEngineConfiguration configuration
 (read only) GAMS Engine configuration
 
containers.Map engineOptions
 (read only) GAMS Engine options
 
cell extraModelFiles
 (read only) Set of extra model files
 
string jobName
 (read only) Job name
 
logical removeResults
 (read only) Flag that determines if OutDB should be created
 
string token
 (read only) Job token string that is returned from successful job creation
 
string workingDirectory
 (read only) Working directory
 

Detailed Description

Manages the execution of a GAMS program given by GAMS model source for GAMS Engine.

See also
GAMSEngineJobBuilder

Member Function Documentation

◆ interrupt()

logical Matlab.GAMS.GAMSEngineJob.interrupt ( )

Send interrupt message to GAMS during GAMSEngineJob instance executes its run method.

This method is useful for interrupting the long running GAMSEngineJob.

Return: true if GAMS has acknowledged an interrupt message, false otherwise

◆ reset()

void Matlab.GAMS.GAMSEngineJob.reset ( )

Removes all of the sets, mappings from this GAMSEngineJob and reset other instance variables.

Though the underlying external resources of the instance variables, if there is any, will not be released.