Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://www.gams.com/latest/docs/apis/java/classcom_1_1gams_1_1api_1_1GAMSWorkspace.html below:

com.gams.api.GAMSWorkspace Class Reference

Loading...

Searching...

No Matches

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 "Software\Classes\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.

In case of using temporary working directory, the temporary working directory will be removed after the GAMSworkspace is out of scope only if either when the debug level is set to GAMSGlobals.DebugLevel.OFF or when there is no error during the lifecycle of the workspace and the debug level is set to GAMSGlobals.DebugLevel.KEEP_FILES_ON_ERROR. Use a user-defined configuration for working directory or set debug level to GAMSGlobals.DebugLevel.KEEP_FILES_ON_ERROR or above in order to keep the working directory after the workspace is terminated or out of scope.

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

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 "Software\Classes\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.

When the working directory is not specified, the default working directory with prefix "gams_" (specified by GAMSGlobals.workingDirectoryPrefix) under the temporary directory (specified by GAMSGlobals.workingDirectory) will be created and taken as the working directory of the workspace. After the working 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.KEEP_FILES_ON_ERROR. 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

GAMSException If 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.KEEP_FILES_ON_ERROR

GAMSGlobals.workingDirectory

GAMSWorkspace.isUsingTmpWorkingDirectory()

GAMSWorkspace.systemDirectory()

GAMSWorkspace.workingDirectory()

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 "Software\Classes\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 default working directory with prefix "gams_" (specified by GAMSGlobals.workingDirectoryPrefix) under the temporary directory (specified by GAMSGlobals.workingDirectory) will be created andtaken 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.KEEP_FILES_ON_ERROR. 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

info a GAMSWorkspaceInfo instance containing information about the user-specified working directory, the user-specified GAMS system directory, and debug level.

Exceptions

GAMSException If 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.KEEP_FILES_ON_ERROR

GAMSGlobals.workingDirectory

GAMSWorkspaceInfo

GAMSWorkspace.isUsingTmpWorkingDirectory()

GAMSWorkspace.systemDirectory()

GAMSWorkspace.workingDirectory()

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 "Software\Classes\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 default working directory with prefix "gams_" (specified by GAMSGlobals.workingDirectoryPrefix) under the temporary directory (specified by GAMSGlobals.workingDirectory) 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

workingDirectory the user-specified working directory where all GAMS files will be stored systemDirectory the user-specified GAMS system directory debugLevel debug level

Exceptions

GAMSException the 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.KEEP_FILES_ON_ERROR

GAMSGlobals.workingDirectory

GAMSWorkspace.isUsingTmpWorkingDirectory()

GAMSWorkspace.systemDirectory()

GAMSWorkspace.workingDirectory()

Create a GAMSCheckpoint.

The name of a GAMSCheckpoint object is generated automatically.

Returns

Reference to GAMSCheckpoint object

Exceptions

GAMSException If GAMSCheckpoint could not be successfully created

Create GAMSCheckpoint.

Parameters

checkpointName Identifier of GAMSCheckpoint or filename for existing checkpoint

Returns

Reference to GAMSCheckpoint object

Exceptions

GAMSException If GAMSCheckpoint could not be successfully created

Create an empty GAMSDatabase.

The name of a GAMSDatabase object is generated automatically.

Returns

Reference to GAMSDatabase object

Exceptions

java.lang.UnsatisfiedLinkError If java property "java.library.path" is not set or the directory specified by the property does not contain valid Java API libraries. GAMSException If GAMSDatabase could not be successfully created

Create Database from existing database.

Parameters

sourceDatabase Source GAMSDatabase to initialize Database from

Returns

Reference to GAMSDatabase object

Exceptions

java.lang.UnsatisfiedLinkError If java property "java.library.path" is not set or the directory specified by the property does not contain valid Java API libraries. GAMSException If GAMSDatabase could not be successfully created

Create Database from existing database.

Parameters

sourceDatabase Source GAMSDatabase to initialize Database from databaseName Identifier of GAMSDatabase

Returns

Reference to GAMSDatabase object

Exceptions

java.lang.UnsatisfiedLinkError If java property "java.library.path" is not set or the directory specified by the property does not contain valid Java API libraries. GAMSException If databaseName already exists in the workspace or GAMSDatabase could not be successfully created

Create an empty GAMSDatabase.

Parameters

databaseName Identifier of GAMSDatabase

Returns

Reference to GAMSDatabase object

Exceptions

java.lang.UnsatisfiedLinkError If java property "java.library.path" is not set or the directory specified by the property does not contain valid Java API libraries. GAMSException If databaseName already exists in the workspace or GAMSDatabase could not be successfully created

Database creation from an existing GDX file.

Parameters

gdxFileName File to initialize Database from

Returns

Reference of GAMSDatabase instance

Exceptions

GAMSException If GAMSDatabase could not be successfully created

Database creation from an existing GDX file.

Parameters

gdxFileName File to initialize Database from databaseName Identifier of GAMSDatabase (determined automatically if null)

Returns

Reference of GAMSDatabase instance

Exceptions

GAMSException If GAMSDatabase could not be successfully created

Retrieves model from GAMS API Library.

Parameters

modelName input model name (without path)

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If the model name could not be found in API Library

Retrieves model from GAMS Data Utilities Library.

Parameters

modelName input model name (without path)

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If the model name could not be found in GAMS Data Utilities Library

Retrieves model from Extended Math Programming Library.

Parameters

modelName input model name (without path)

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If the model name could not be found in GAMS Extended Math Programming Library

Create GAMSJob from model file.

Parameters

fileName Source file name

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If GAMSJob could not be successfully created from the source file name

Create GAMSJob from model file.

Parameters

fileName Source file name checkpoint GAMSCheckpoint to initialize GAMSJob from jobName Job name (determined automatically if null)

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If GAMSJob could not be successfully created

Create GAMSJob from model file.

Parameters

fileName Source file name jobName Job name (determined automatically if null)

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If GAMSJob could not be successfully created

Retrieves model from GAMS Practical Financial Optimization Library.

Parameters

modelName input model name (without path)

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If the model name could not be found in GAMS Financial Optimization Library

Retrieves model from GAMS Model Library.

Parameters

modelName input model name (without path)

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If the model name could not be found in GAMS Model Library

Retrieves model from GAMS Non-linear Optimization Applications Library.

Parameters

modelName input model name (without path)

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If the model name could not be found in Non-linear Optimization Applications Library

Retrieves model from Power System Optimization Modelling Library.

Parameters

modelName input model name (without path)

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If the model name could not be found in Power System Optimization Modelling Library

Create GAMSJob from string model source.

Parameters

source GAMS model as string

Returns

Reference to GAMSJob object

Exceptions

GAMSException If GAMSJob could not be successfully created

Create GAMSJob from string model source.

The job name is generated automatically.

Parameters

source GAMS model as string checkpoint GAMSCheckpoint to initialize GAMSJob from

Returns

Reference to GAMSJob object

Exceptions

GAMSException If GAMSJob could not be successfully created

Create GAMSJob from string model source.

Parameters

source GAMS model as string checkpoint GAMSCheckpoint to initialize GAMSJob from jobName Job name

Returns

Reference to GAMSJob object

Exceptions

GAMSException If GAMSJob could not be successfully created

Retrieves model from GAMS Test Library.

Parameters

modelName input model name (without path)

Returns

Reference to GAMSJob instance

Exceptions

GAMSException If the model name could not be found in GAMS Test Library

Create GAMSOptions.

Returns

Reference to GAMSOptions object

Exceptions

GAMSException If GAMSOptions could not be successfully created

Create GAMSOptions from a GAMSOptions object.

Parameters

option Reference to GAMSObject object

Returns

Reference to GAMSOptions object

Exceptions

GAMSException If GAMSOptions could not be successfully created

Since

24.2

Create GAMSOptions from an option file.

Parameters

optionFile Option file name

Returns

Reference to GAMSOptions object

Exceptions

GAMSException If GAMSOptions could not be successfully created

Since

24.2

Deprecated

Deprecated since 50.0, this finalize method is subject to removal in a future version. The temporary working directory will be eventually removed in case either the debug level is set GAMSGlobals.DebugLevel.OFF or there is no error and the debug level is not set to GAMSGlobals.DebugLevel.KEEP_FILES_ON_ERROR or above.

The accessibility has been set back from pubilc to protected since 25.1.

get API GOLD Release Number

Since

24.2

get API Major Release Number

Since

24.2

get API Minor Release Number

Since

24.2

get API Version

Since

24.2

Retrieve the debug level.

Returns

debug level

See also

GAMSGlobals.DebugLevel

Get GAMS Version used.

Since

24.2

get GAMS GOLD Release Number

Since

24.2

Get GAMS Major Release Number.

Since

24.2

Get GAMS Minor Release Number.

Since

24.2

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.

Set the debug level.

Parameters

See also

GAMSGlobals.DebugLevel

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

Retrieve the system directory.

Returns

String described the system directory

Retrieve the working directory.

Returns

String described the working directory

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4