Input parameter for the Workspace constructor. More...

Public Member Functions
	WorkspaceInfo (varargin)
	Constructs a new WorkspaceInfo instance.

Public Attributes
gams.control.globals.DebugLevel	debugLevel
	GAMS debug level.

string	systemDirectory
	GAMS system directory.

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

Detailed Description

Input parameter for the Workspace constructor.

The WorkspaceInfo contains essential information for initializing Workspace: 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 globals.DebugLevel.OFF, i.e., no debug information available.

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

Example:

* wsInfo = \ref matlab.gams.control.WorkspaceInfo "WorkspaceInfo"();
* wsInfo.workingDirectory = pwd;
* wsInfo.debugLevel = \ref matlab.gams.control.globals.DebugLevel.SHOW "globals.DebugLevel.SHOW"_LOG;
* workspace = \ref matlab.gams.control.Workspace "Workspace"(wsInfo);
*

See also: Workspace, globals.DebugLevel

Constructor & Destructor Documentation

◆ WorkspaceInfo()

matlab.gams.control.WorkspaceInfo.WorkspaceInfo ( varargin )

Constructs a new WorkspaceInfo instance.

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

Valid VARARGIN signatures:

[ ]
string workingDir, string systemDir, globals.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 WorkspaceInfo

See also: globals.DebugLevel

Member Data Documentation

◆ debugLevel

gams.control.globals.DebugLevel matlab.gams.control.WorkspaceInfo.debugLevel

GAMS debug level.

See also: globals.DebugLevel

◆ systemDirectory

string matlab.gams.control.WorkspaceInfo.systemDirectory

GAMS system directory.

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

See also: Workspace

◆ workingDirectory

string matlab.gams.control.WorkspaceInfo.workingDirectory

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