Matlab.GAMS.GAMSWorkspaceInfo Class Reference

Input parameter for the GAMSWorkspace constructor. More...

Public Member Functions

 GAMSWorkspaceInfo (varargin)
 Constructs a new GAMSWorkspaceInfo instance. More...
 

Public Attributes

DebugLevel debugLevel
 GAMS debug level. More...
 
string systemDirectory
 GAMS system directory. More...
 
string workingDirectory
 GAMS working directory, anchor for all file-based operations. More...
 

Detailed Description

Input parameter for the GAMSWorkspace constructor.

The GAMSWorkspaceInfo contains essential information for initializing GAMSWorkspace: GAMS working directory, GAMS system directory, and GAMS debug level. The GAMS system directory is the directory where GAMS has been installed. The default value of the working directory is an empty string. The GAMS working directory anchors for all file-based operations. The default value of the working directory is an empty string. GAMS debug level indicates how GAMS produces debug messages during the execution. The default value of the debug level is DebugLevel.OFF, i.e., no debug information available.

Note
Once GAMSWorkspace has been constructed using information from GAMSWorkspaceInfo object, changing an attribute value of the GAMSWorkspaceInfo object will not change the attribute value of GAMSWorkspace object.

Example:

* wsInfo = GAMS.GAMSWorkspaceInfo();
* wsInfo.workingDirectory = pwd;
* wsInfo.debugLevel = GAMS.DebugLevel.SHOW_LOG;
* workspace = GAMS.GAMSWorkspace(wsInfo);
* 
See also
GAMSWorkspace, DebugLevel

Constructor & Destructor Documentation

◆ GAMSWorkspaceInfo()

Matlab.GAMS.GAMSWorkspaceInfo.GAMSWorkspaceInfo ( varargin  )

Constructs a new GAMSWorkspaceInfo instance.

The default value of GAMS working directory and GAMS System directory are NULL, and the default value of the debug level is GAMS.DebugLevel.OFF, no debug information available.

Valid VARARGIN signatures:

  • [ ]
  • string workingDir, string systemDir, DebugLevel level

Arguments:

  • workingDir: the name of working directory, anchor for all file-based operations
  • systemDir: the name of system directory, where GAMS is installed
  • level: debug level

Return: instance of GAMSWorkspaceInfo

See also
DebugLevel

Member Data Documentation

◆ debugLevel

DebugLevel Matlab.GAMS.GAMSWorkspaceInfo.debugLevel

GAMS debug level.

See also
DebugLevel

◆ systemDirectory

string Matlab.GAMS.GAMSWorkspaceInfo.systemDirectory

GAMS system directory.

The specified directory will be verified later when a GAMSWorkspace instance is created from the information specified by this GAMSWorkspaceInfo instance.

See also
GAMSWorkspace

◆ workingDirectory

string Matlab.GAMS.GAMSWorkspaceInfo.workingDirectory

GAMS working directory, anchor for all file-based operations.

The specified directory will be verified later when a GAMSWorkspace instance is created from the information specified by this GAMSWorkspaceInfo instance.

See also
GAMSWorkspace