com.gams.api.GAMSWorkspace Class Reference

Public Member Functions

 GAMSWorkspace ()
 
 GAMSWorkspace (GAMSWorkspaceInfo info)
 
 GAMSWorkspace (String workingDirectory, String systemDirectory, GAMSGlobals.DebugLevel debugLevel)
 
GAMSJob addJobFromGamsLib (String modelName)
 Retrieves model from GAMS Model Library. More...
 
GAMSJob addJobFromTestLib (String modelName)
 Retrieves model from GAMS Test Library. More...
 
GAMSJob addJobFromDataLib (String modelName)
 Retrieves model from GAMS Data Utilities Library. More...
 
GAMSJob addJobFromFinLib (String modelName)
 Retrieves model from GAMS Practical Financial Optimization Library. More...
 
GAMSJob addJobFromEmpLib (String modelName)
 Retrieves model from Extended Math Programming Library. More...
 
GAMSJob addJobFromApiLib (String modelName)
 Retrieves model from GAMS API Library. More...
 
GAMSJob addJobFromNoaLib (String modelName)
 Retrieves model from GAMS Non-linear Optimization Applications Library. More...
 
GAMSJob addJobFromFile (String fileName)
 Create GAMSJob from model file. More...
 
GAMSJob addJobFromFile (String fileName, String jobName)
 Create GAMSJob from model file. More...
 
GAMSJob addJobFromFile (String fileName, GAMSCheckpoint checkpoint, String jobName)
 Create GAMSJob from model file. More...
 
GAMSDatabase addDatabaseFromGDX (String gdxFileName)
 Database creation from an existing GDX file. More...
 
GAMSDatabase addDatabaseFromGDX (String gdxFileName, String databaseName)
 Database creation from an existing GDX file. More...
 
GAMSJob addJobFromString (String source)
 Create GAMSJob from string model source. More...
 
GAMSJob addJobFromString (String source, GAMSCheckpoint checkpoint)
 Create GAMSJob from string model source. More...
 
GAMSJob addJobFromString (String source, GAMSCheckpoint checkpoint, String jobName)
 Create GAMSJob from string model source. More...
 
GAMSDatabase addDatabase ()
 Create an empty GAMSDatabase. More...
 
GAMSDatabase addDatabase (String databaseName)
 Create an empty GAMSDatabase. More...
 
GAMSDatabase addDatabase (GAMSDatabase sourceDatabase)
 Create Database from existing database. More...
 
GAMSDatabase addDatabase (GAMSDatabase sourceDatabase, String databaseName)
 Create Database from existing database. More...
 
GAMSCheckpoint addCheckpoint ()
 Create a GAMSCheckpoint. More...
 
GAMSCheckpoint addCheckpoint (String checkpointName)
 Create GAMSCheckpoint. More...
 
GAMSOptions addOptions ()
 Create GAMSOptions. More...
 
GAMSOptions addOptions (GAMSOptions option)
 Create GAMSOptions from a GAMSOptions object. More...
 
GAMSOptions addOptions (String optionFile)
 Create GAMSOptions from an option file. More...
 
String workingDirectory ()
 Retrieve the working directory. More...
 
String systemDirectory ()
 Retrieve the system directory. More...
 
boolean isUsingTmpWorkingDirectory ()
 Retrieve the flag if the user's directory (that is System.getProperty("java.io.tmpdir")) has been used as a working directory. More...
 
GAMSGlobals.DebugLevel getDebugLevel ()
 Retrieve the debug level. More...
 
void setDebugLevel (GAMSGlobals.DebugLevel level)
 Set the debug level. More...
 
String getGAMSVersion ()
 Get GAMS Version used. More...
 
int getMajorReleaseNumber ()
 Get GAMS Major Release Number. More...
 
int getMinorReleaseNumber ()
 Get GAMS Minor Release Number. More...
 
int getGoldReleaseNumber ()
 get GAMS GOLD Release Number More...
 
void setMyEPS (double value)
 Reset the value of GAMSGlobals.SpecialValues.EPS, the value to be stored in and read from GAMSDatabase for Epsilon. More...
 
void finalize () throws Throwable
 Clean up temporary files in working directory in case debug level is not set to GAMSGlobals.DebugLevel.KEEP_FILES or above. More...
 

Static Public Member Functions

static String getAPIVersion ()
 get API Version More...
 
static int getAPIMajorReleaseNumber ()
 get API Major Release Number More...
 
static int getAPIMinorReleaseNumber ()
 get API Minor Release Number More...
 
static int getAPIGoldReleaseNumber ()
 get API GOLD Release Number More...
 

Detailed Description

The GAMSWorkspace is the base class in the com.gams.api package. Most instances of API program under the package (such as GAMSDatabase, GAMSJob, and GAMSCheckpoint) have to be created by an "add" method provided by GAMSWorkspace.

When creating a GAMSWorkspace instance, it is possible to use a default configuration or a user-defined configuration to specify workspace attributes (system directory, working directory, and debug level) of the instance.

  • The system directory is the directory where GAMS system has been installed. It provides most resources from GAMS required by an API program.
  • The working directory is the anchor directory where all file based operation inside a running GAMS model should be relative to this location (e.g. $GDXIN and $include). Though there are also options to add input search paths (e.g. IDir) and output path (e.g. PutDir) to specify other file system locations provided by GAMSOptions. It is recommended to clean up the working directory after running an example, if the output files are no longer needed.
  • The debug level is the level of debug information that can be set to various value when more or less information is needed during run time.

For a default configuration, a GAMSWorkspace instance is created by the default constructor without a parameter. In such case, the workspace attributes will be determined using the default setting.

  • The system directory will be determined automatically from the environment (first, from "PATH" environment variable on every platform. If a GAMS system directory is not found from "PATH", the system directory will be determined from the platform specific environment: from windows registry "gams.location" on Windows-based platform, from "DYLD_LIBRARY_PATH" on Mac OS platform, or from "LD_LIBRARY_PATH" on other Unix-based platforms). If a valid GAMS system directory could not be found from both environment variables, GAMSException will be raised during run time.
  • The working directory will be determined from GAMSGlobals.workingDirectory which by default is the user working directory (the java property "java.io.tmpdir").
  • The debug level is set to GAMSGlobals.DebugLevel.OFF by default, that is no debug information available.

To create a GAMSWorkspace instance with a user-defined configuration, it is possible to specify one of workspace attributes (system directory, working directory, and debug level) by either using GAMSWorkspace(String, String, GAMSGlobals.DebugLevel) constructor or creating first a GAMSWorkspaceInfo instance that contains attribute values and then passing it as input parameter for one of the GAMSWorkspace constructors. Either way, both specified system directory and working directory will be verified whether or not they are valid directories. In case of an invalid directory, GAMSException will be raised during run time. In general, the directory is not a valid directory if it is does not exist. The directory contains either an empty string or only white spaces will be treated as non existent directory whereas the null directory will be treated with the default setting. The system directory is not a valid GAMS directory if it does not contain valid GAMS files and libraries. The valid system directory will be used and not be verified against an environment variable.

Note
If you use multiple instances of the GAMSWorkspace in parallel, you should avoid using the same working directory. Otherwise you may end up with conflicting file names.

As most API operations, such as database operations, requires API libraries to accomplish the operations, it is important to set java property "java.library.path" to the directory containing valid Java API libraries when running a program. In case the java library path is not set or the directory does not contain a valid Java API libraries, java.lang.UnsatisfiedLinkError will be raised during run time. In case there is a conflict between the system directory and the java library path containing API libraries, API libraries will print a warning message, that API version found from the library path is different than GAMS version found from the system directory.

See also
GAMSCheckpoint
GAMSDatabase
GAMSGlobals
GAMSJob
GAMSOptions
GAMSWorkspaceInfo
GAMSGlobals.DebugLevel

Constructor & Destructor Documentation

◆ GAMSWorkspace() [1/3]

com.gams.api.GAMSWorkspace.GAMSWorkspace ( )

Construct a new GAMSWorkspace instance using the default configuration. All of the workspace attributes will be determined using the default setting.

For the system directory, the system directory will be determined automatically from the environment (first, from "PATH" environment variable on every platform. If a GAMS system directory is not found from "PATH", the system directory will be determined from the platform specific environment: either from windows registry "gams.location" on Windows-based platform, or from "DYLD_LIBRARY_PATH" on Mac OS platform, or from "LD_LIBRARY_PATH" on other Unix-based platforms). If a valid GAMS system directory could not be found from both environment variables, GAMSException will be raised during run time.

For the working directory, the directory of date format "yyyyMMdd_HHmmss" under the directory specified by GAMSGlobals.workingDirectory (java property "java.io.tmpdir" as its default value) will be created and taken as the working directory of the workspace. After the directory is successfully created, the call of method GAMSWorkspace.workingDirectory() will return the string describing the working directory and the call of the method GAMSWorkspace.isUsingTmpWorkingDirectory() will return true. Under situation where the directory could not be created, the directory specified by specified by GAMSGlobals.workingDirectory will be taken as the working directory of the workspace. Under such situation, the call of method GAMSWorkspace.workingDirectory() will return the working directory string and the call of the method GAMSWorkspace.isUsingTmpWorkingDirectory() will return false.

The debug level is, by default, GAMSGlobals.DebugLevel.OFF. When a GAMSWorkspace instance is created, it also allows an environment variable "GAMSOOAPIDEBUG" containing a String that represents the desired DebugLevel to override the debug level of the created workspace instance.

Exceptions
GAMSExceptionIf the environment variable does not contain a valid GAMS system directory, or the directory specified by the java property "java.library.path" contains Java API libraries which conflict with the platform architecture the program is running on.
See also
GAMSGlobals.DebugLevel
GAMSGlobals.DebugLevel.lookup(int)
GAMSGlobals.DebugLevel.lookup(String)
GAMSGlobals.DebugLevel.message()
GAMSGlobals.DebugLevel.OFF
GAMSGlobals.workingDirectory
GAMSWorkspace.isUsingTmpWorkingDirectory()
GAMSWorkspace.systemDirectory()
GAMSWorkspace.workingDirectory()

◆ GAMSWorkspace() [2/3]

com.gams.api.GAMSWorkspace.GAMSWorkspace ( GAMSWorkspaceInfo  info)

Construct a new GAMSWorkspace instance from GAMSWorkspaceInfo instance. All of the workspace attributes will be determined from attributes of GAMSWorkspaceInfo.

In case the system directory attribute is null or not specified (by default setting), the system directory will be determined automatically from the environment (first, from "PATH" environment variable on every platform. If a GAMS system directory is not found from "PATH", the system directory will be determined from the platform specific environment: either from windows registry "gams.location" on Windows-based platform, or from "DYLD_LIBRARY_PATH" on Mac OS platform, or from "LD_LIBRARY_PATH" on other Unix-based platforms). If a valid GAMS system directory could not be found from both environment variables, GAMSException will be raised during run time.

In case the specified system directory is not null, the directory will be verified. In case the specified directory does not exist or it is not a valid GAMS directory, GAMSException will be raised during run time.

In case the specified working directory is null or not specified (by default setting), the directory of date format "yyyyMMdd_HHmmss" under the directory specified by GAMSGlobals.workingDirectory (java property "java.io.tmpdir" as its default value) will be created and taken as the working directory of the workspace. After the directory is successfully created, the call of method GAMSWorkspace.workingDirectory() will return the string describing the working directory and the call of the method GAMSWorkspace.isUsingTmpWorkingDirectory() will return true. Under situation where the directory could not be created, the directory specified by specified by GAMSGlobals.workingDirectory will be taken as the working directory of the workspace. Under such situation, the call of method GAMSWorkspace.workingDirectory() will return the working directory string and the call of the method GAMSWorkspace.isUsingTmpWorkingDirectory() will return false.

In case the specified working directory is not null, the directory will be verified. In case the specified directory does exist but not a directory, GAMSException will be raised during run time. Otherwise the directory will be created.

The debug level attribute is, by default of creating a GAMSWorkspaceInfo, GAMSGlobals.DebugLevel.OFF. The debug level can be specified to other value by an instance of GAMSGlobals.DebugLevel. Note that When a GAMSWorkspace instance is created, it also allows an environment variable "GAMSOOAPIDEBUG" containing a String that represents the desired DebugLevel to override the debug level of the created instance.

Parameters
infoa GAMSWorkspaceInfo instance containing information about the user-specified working directory, the user-specified GAMS system directory, and debug level.
Exceptions
GAMSExceptionIf either info instance is null, or the specified directory does not exist, or the specified system directory is not a valid GAMS directory, or the directory specified by the java property "java.library.path" contains Java API libraries which conflict with the platform architecture the program is running on.
See also
GAMSGlobals.DebugLevel
GAMSGlobals.DebugLevel.lookup(int)
GAMSGlobals.DebugLevel.lookup(String)
GAMSGlobals.DebugLevel.message()
GAMSGlobals.DebugLevel.OFF
GAMSGlobals.workingDirectory
GAMSWorkspaceInfo
GAMSWorkspace.isUsingTmpWorkingDirectory()
GAMSWorkspace.systemDirectory()
GAMSWorkspace.workingDirectory()

◆ GAMSWorkspace() [3/3]

com.gams.api.GAMSWorkspace.GAMSWorkspace ( String  workingDirectory,
String  systemDirectory,
GAMSGlobals.DebugLevel  debugLevel 
)

Construct a new GAMSWorkspace instance.

In case the system directory attribute is null, the system directory will be determined automatically from the environment (first, from "PATH" environment variable on every platform. If a GAMS system directory is not found from "PATH", the system directory will be determined from the platform specific environment: either from windows registry "gams.location" on Windows-based platform, or from "DYLD_LIBRARY_PATH" on Mac OS platform, or from "LD_LIBRARY_PATH" on other Unix-based platforms). If a valid GAMS system directory could not be found from both environment variables, GAMSException will be raised during run time.

In case the specified system directory is not null, the directory will be verified. In case the specified directory does not exist or it is not a valid GAMS directory, GAMSException will be raised during run time.

In case the specified working directory is null, the directory of date format "yyyyMMdd_HHmmss" under the directory specified by GAMSGlobals.workingDirectory (java property "java.io.tmpdir" as its default value) will be created and taken as the working directory of the workspace. After the directory is successfully created, the call of method GAMSWorkspace.workingDirectory() will return the string describing the working directory and the call of the method GAMSWorkspace.isUsingTmpWorkingDirectory() will return true. Under situation where the directory could not be created, the directory specified by specified by GAMSGlobals.workingDirectory will be taken as the working directory of the workspace. Under such situation, the call of method GAMSWorkspace.workingDirectory() will return the working directory string and the call of the method GAMSWorkspace.isUsingTmpWorkingDirectory() will return false.

In case the specified working directory is not null, the directory will be verified. In case the specified directory does exist but not a directory, GAMSException will be raised during run time. Otherwise the directory will be created.

The debug level can be specified by an instance of GAMSGlobals.DebugLevel. When a GAMSWorkspace instance is created, it also allows an environment variable "GAMSOOAPIDEBUG" containing a String that represents the desired DebugLevel to override the debug level of the created instance.

Parameters
workingDirectorythe user-specified working directory where all GAMS files will be stored
systemDirectorythe user-specified GAMS system directory
debugLeveldebug level
Exceptions
GAMSExceptionthe specified system directory does not exist, or the specified system directory is not a valid GAMS directory, or the directory specified by the java property "java.library.path" contains Java API libraries which conflict with the platform architecture the program is running on.
See also
GAMSGlobals.DebugLevel
GAMSGlobals.DebugLevel.lookup(int)
GAMSGlobals.DebugLevel.lookup(String)
GAMSGlobals.DebugLevel.message()
GAMSGlobals.DebugLevel.OFF
GAMSGlobals.workingDirectory
GAMSWorkspace.isUsingTmpWorkingDirectory()
GAMSWorkspace.systemDirectory()
GAMSWorkspace.workingDirectory()

Member Function Documentation

◆ addCheckpoint() [1/2]

GAMSCheckpoint com.gams.api.GAMSWorkspace.addCheckpoint ( )

Create a GAMSCheckpoint.

The name of a GAMSCheckpoint object is generated automatically.

Returns
Reference to GAMSCheckpoint object
Exceptions
GAMSExceptionIf GAMSCheckpoint could not be successfully created

◆ addCheckpoint() [2/2]

GAMSCheckpoint com.gams.api.GAMSWorkspace.addCheckpoint ( String  checkpointName)

Create GAMSCheckpoint.

Parameters
checkpointNameIdentifier of GAMSCheckpoint or filename for existing checkpoint
Returns
Reference to GAMSCheckpoint object
Exceptions
GAMSExceptionIf GAMSCheckpoint could not be successfully created

◆ addDatabase() [1/4]

GAMSDatabase com.gams.api.GAMSWorkspace.addDatabase ( )

Create an empty GAMSDatabase.

The name of a GAMSDatabase object is generated automatically.

Returns
Reference to GAMSDatabase object
Exceptions
java.lang.UnsatisfiedLinkErrorIf java property "java.library.path" is not set or the directory specified by the property does not contain valid Java API libraries.
GAMSExceptionIf GAMSDatabase could not be successfully created

◆ addDatabase() [2/4]

GAMSDatabase com.gams.api.GAMSWorkspace.addDatabase ( String  databaseName)

Create an empty GAMSDatabase.

Parameters
databaseNameIdentifier of GAMSDatabase
Returns
Reference to GAMSDatabase object
Exceptions
java.lang.UnsatisfiedLinkErrorIf java property "java.library.path" is not set or the directory specified by the property does not contain valid Java API libraries.
GAMSExceptionIf GAMSDatabase could not be successfully created

◆ addDatabase() [3/4]

GAMSDatabase com.gams.api.GAMSWorkspace.addDatabase ( GAMSDatabase  sourceDatabase)

Create Database from existing database.

Parameters
sourceDatabaseSource GAMSDatabase to initialize Database from
Returns
Reference to GAMSDatabase object
Exceptions
java.lang.UnsatisfiedLinkErrorIf java property "java.library.path" is not set or the directory specified by the property does not contain valid Java API libraries.
GAMSExceptionIf GAMSDatabase could not be successfully created

◆ addDatabase() [4/4]

GAMSDatabase com.gams.api.GAMSWorkspace.addDatabase ( GAMSDatabase  sourceDatabase,
String  databaseName 
)

Create Database from existing database.

Parameters
sourceDatabaseSource GAMSDatabase to initialize Database from
databaseNameIdentifier of GAMSDatabase
Returns
Reference to GAMSDatabase object
Exceptions
java.lang.UnsatisfiedLinkErrorIf java property "java.library.path" is not set or the directory specified by the property does not contain valid Java API libraries.
GAMSExceptionIf GAMSDatabase could not be successfully created

◆ addDatabaseFromGDX() [1/2]

GAMSDatabase com.gams.api.GAMSWorkspace.addDatabaseFromGDX ( String  gdxFileName)

Database creation from an existing GDX file.

Parameters
gdxFileNameFile to initialize Database from
Returns
Reference of GAMSDatabase instance
Exceptions
GAMSExceptionIf GAMSDatabase could not be successfully created

◆ addDatabaseFromGDX() [2/2]

GAMSDatabase com.gams.api.GAMSWorkspace.addDatabaseFromGDX ( String  gdxFileName,
String  databaseName 
)

Database creation from an existing GDX file.

Parameters
gdxFileNameFile to initialize Database from
databaseNameIdentifier of GAMSDatabase (determined automatically if null)
Returns
Reference of GAMSDatabase instance
Exceptions
GAMSExceptionIf GAMSDatabase could not be successfully created

◆ addJobFromApiLib()

GAMSJob com.gams.api.GAMSWorkspace.addJobFromApiLib ( String  modelName)

Retrieves model from GAMS API Library.

Parameters
modelNameinput model name (without path)
Returns
Reference to GAMSJob instance
Exceptions
GAMSExceptionIf the model name could not be found in API Library

◆ addJobFromDataLib()

GAMSJob com.gams.api.GAMSWorkspace.addJobFromDataLib ( String  modelName)

Retrieves model from GAMS Data Utilities Library.

Parameters
modelNameinput model name (without path)
Returns
Reference to GAMSJob instance
Exceptions
GAMSExceptionIf the model name could not be found in GAMS Data Utilities Library

◆ addJobFromEmpLib()

GAMSJob com.gams.api.GAMSWorkspace.addJobFromEmpLib ( String  modelName)

Retrieves model from Extended Math Programming Library.

Parameters
modelNameinput model name (without path)
Returns
Reference to GAMSJob instance
Exceptions
GAMSExceptionIf the model name could not be found in GAMS Extended Math Programming Library

◆ addJobFromFile() [1/3]

GAMSJob com.gams.api.GAMSWorkspace.addJobFromFile ( String  fileName)

Create GAMSJob from model file.

Parameters
fileNameSource file name
Returns
Reference to GAMSJob instance
Exceptions
GAMSExceptionIf GAMSJob could not be successfully created from the source file name

◆ addJobFromFile() [2/3]

GAMSJob com.gams.api.GAMSWorkspace.addJobFromFile ( String  fileName,
String  jobName 
)

Create GAMSJob from model file.

Parameters
fileNameSource file name
jobNameJob name (determined automatically if null)
Returns
Reference to GAMSJob instance
Exceptions
GAMSExceptionIf GAMSJob could not be successfully created

◆ addJobFromFile() [3/3]

GAMSJob com.gams.api.GAMSWorkspace.addJobFromFile ( String  fileName,
GAMSCheckpoint  checkpoint,
String  jobName 
)

Create GAMSJob from model file.

Parameters
fileNameSource file name
checkpointGAMSCheckpoint to initialize GAMSJob from
jobNameJob name (determined automatically if null)
Returns
Reference to GAMSJob instance
Exceptions
GAMSExceptionIf GAMSJob could not be successfully created

◆ addJobFromFinLib()

GAMSJob com.gams.api.GAMSWorkspace.addJobFromFinLib ( String  modelName)

Retrieves model from GAMS Practical Financial Optimization Library.

Parameters
modelNameinput model name (without path)
Returns
Reference to GAMSJob instance
Exceptions
GAMSExceptionIf the model name could not be found in GAMS Financial Optimization Library

◆ addJobFromGamsLib()

GAMSJob com.gams.api.GAMSWorkspace.addJobFromGamsLib ( String  modelName)

Retrieves model from GAMS Model Library.

Parameters
modelNameinput model name (without path)
Returns
Reference to GAMSJob instance
Exceptions
GAMSExceptionIf the model name could not be found in GAMS Model Library

◆ addJobFromNoaLib()

GAMSJob com.gams.api.GAMSWorkspace.addJobFromNoaLib ( String  modelName)

Retrieves model from GAMS Non-linear Optimization Applications Library.

Parameters
modelNameinput model name (without path)
Returns
Reference to GAMSJob instance
Exceptions
GAMSExceptionIf the model name could not be found in Non-linear Optimization Applications Library

◆ addJobFromString() [1/3]

GAMSJob com.gams.api.GAMSWorkspace.addJobFromString ( String  source)

Create GAMSJob from string model source.

Parameters
sourceGAMS model as string
Returns
Reference to GAMSJob object
Exceptions
GAMSExceptionIf GAMSJob could not be successfully created

◆ addJobFromString() [2/3]

GAMSJob com.gams.api.GAMSWorkspace.addJobFromString ( String  source,
GAMSCheckpoint  checkpoint 
)

Create GAMSJob from string model source.

The job name is generated automatically.

Parameters
sourceGAMS model as string
checkpointGAMSCheckpoint to initialize GAMSJob from
Returns
Reference to GAMSJob object
Exceptions
GAMSExceptionIf GAMSJob could not be successfully created

◆ addJobFromString() [3/3]

GAMSJob com.gams.api.GAMSWorkspace.addJobFromString ( String  source,
GAMSCheckpoint  checkpoint,
String  jobName 
)

Create GAMSJob from string model source.

Parameters
sourceGAMS model as string
checkpointGAMSCheckpoint to initialize GAMSJob from
jobNameJob name
Returns
Reference to GAMSJob object
Exceptions
GAMSExceptionIf GAMSJob could not be successfully created

◆ addJobFromTestLib()

GAMSJob com.gams.api.GAMSWorkspace.addJobFromTestLib ( String  modelName)

Retrieves model from GAMS Test Library.

Parameters
modelNameinput model name (without path)
Returns
Reference to GAMSJob instance
Exceptions
GAMSExceptionIf the model name could not be found in GAMS Test Library

◆ addOptions() [1/3]

GAMSOptions com.gams.api.GAMSWorkspace.addOptions ( )

Create GAMSOptions.

Returns
Reference to GAMSOptions object
Exceptions
GAMSExceptionIf GAMSOptions could not be successfully created

◆ addOptions() [2/3]

GAMSOptions com.gams.api.GAMSWorkspace.addOptions ( GAMSOptions  option)

Create GAMSOptions from a GAMSOptions object.

Parameters
optionReference to GAMSObject object
Returns
Reference to GAMSOptions object
Exceptions
GAMSExceptionIf GAMSOptions could not be successfully created
Since
24.2

◆ addOptions() [3/3]

GAMSOptions com.gams.api.GAMSWorkspace.addOptions ( String  optionFile)

Create GAMSOptions from an option file.

Parameters
optionFileOption file name
Returns
Reference to GAMSOptions object
Exceptions
GAMSExceptionIf GAMSOptions could not be successfully created
Since
24.2

◆ finalize()

void com.gams.api.GAMSWorkspace.finalize ( ) throws Throwable

Clean up temporary files in working directory in case debug level is not set to GAMSGlobals.DebugLevel.KEEP_FILES or above.

Exceptions
exceptionor error raised by calling finalize().

◆ getAPIGoldReleaseNumber()

static int com.gams.api.GAMSWorkspace.getAPIGoldReleaseNumber ( )
static

get API GOLD Release Number

Since
24.2

◆ getAPIMajorReleaseNumber()

static int com.gams.api.GAMSWorkspace.getAPIMajorReleaseNumber ( )
static

get API Major Release Number

Since
24.2

◆ getAPIMinorReleaseNumber()

static int com.gams.api.GAMSWorkspace.getAPIMinorReleaseNumber ( )
static

get API Minor Release Number

Since
24.2

◆ getAPIVersion()

static String com.gams.api.GAMSWorkspace.getAPIVersion ( )
static

get API Version

Since
24.2

◆ getDebugLevel()

GAMSGlobals.DebugLevel com.gams.api.GAMSWorkspace.getDebugLevel ( )

Retrieve the debug level.

Returns
debug level
See also
GAMSGlobals.DebugLevel

◆ getGAMSVersion()

String com.gams.api.GAMSWorkspace.getGAMSVersion ( )

Get GAMS Version used.

Since
24.2

◆ getGoldReleaseNumber()

int com.gams.api.GAMSWorkspace.getGoldReleaseNumber ( )

get GAMS GOLD Release Number

Since
24.2

◆ getMajorReleaseNumber()

int com.gams.api.GAMSWorkspace.getMajorReleaseNumber ( )

Get GAMS Major Release Number.

Since
24.2

◆ getMinorReleaseNumber()

int com.gams.api.GAMSWorkspace.getMinorReleaseNumber ( )

Get GAMS Minor Release Number.

Since
24.2

◆ isUsingTmpWorkingDirectory()

boolean com.gams.api.GAMSWorkspace.isUsingTmpWorkingDirectory ( )

Retrieve the flag if the user's directory (that is System.getProperty("java.io.tmpdir")) has been used as a working directory.

Returns
true if the user's directory has been used as a working directory, false otherwise.

◆ setDebugLevel()

void com.gams.api.GAMSWorkspace.setDebugLevel ( GAMSGlobals.DebugLevel  level)

Set the debug level.

Parameters
leveldebug level
See also
GAMSGlobals.DebugLevel

◆ setMyEPS()

void com.gams.api.GAMSWorkspace.setMyEPS ( double  value)

Reset the value of GAMSGlobals.SpecialValues.EPS, the value to be stored in and read from GAMSDatabase for Epsilon.

Since
24.2
See also
GAMSGlobals.SpecialValues.EPS

◆ systemDirectory()

String com.gams.api.GAMSWorkspace.systemDirectory ( )

Retrieve the system directory.

Returns
String described the system directory

◆ workingDirectory()

String com.gams.api.GAMSWorkspace.workingDirectory ( )

Retrieve the working directory.

Returns
String described the working directory