Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
matlab.gams.control.globals.DebugLevel Class Reference

Define GAMS Debug Level of different values and string representations. More...

Public Member Functions

logical equals (varargin)
 Compare if the parameter is of the same DebugLevel.
 
logical isHigherThan (varargin)
 Compare if this debug level has higher level than the parameter.
 
logical isLowerThan (varargin)
 Compare if this debug level has lower level than the parameter.
 
string message ()
 Get the string representing the debug level of this enumerated DebugLevel instance.
 

Public Attributes

string select
 Selection of enum options.
 
integer value
 Value of enum options.
 

Static Public Attributes

static final KEEP_FILES = 2
 Keep temporary files, string representation "keepfiles".
 
static final KEEP_FILES_ON_ERROR = 1
 Keep temporary files only in case of an error/exception.
 
static final OFF = 0
 No Debug, string representation "off".
 
static final SHOW_LOG = 3
 Send GAMS log to standard output and keep temporary files, string representation "showlog".
 
static final UNDEFINED_LEVEL = 5
 Undefined option, string representation "undefined".
 
static final VERBOSE = 4
 Send highly technical info and GAMS log to standard output and keep temporary file, string representation "verbose".
 

Detailed Description

Define GAMS Debug Level of different values and string representations.

When a Workspace instance is created, it also allows an environment variable "GAMSOOAPIDEBUG" containing a String representing the DebugLevel to override the debug level that has been set from either a WorkspaceInfo instance or a String instance parameter of a Workspace constructor.

See also
Workspace, WorkspaceInfo

Member Function Documentation

◆ equals()

logical matlab.gams.control.globals.DebugLevel.equals ( varargin  )

Compare if the parameter is of the same DebugLevel.

Arguments:

  • another: GAMS data type

◆ isHigherThan()

logical matlab.gams.control.globals.DebugLevel.isHigherThan ( varargin  )

Compare if this debug level has higher level than the parameter.

Arguments:

  • level: debug level

Return: true if this debug level has higher level than the parameter, false otherwise

◆ isLowerThan()

logical matlab.gams.control.globals.DebugLevel.isLowerThan ( varargin  )

Compare if this debug level has lower level than the parameter.

Arguments:

  • level: debug level

Return: true if this debug level has lower level than the parameter, false otherwise

◆ message()

string matlab.gams.control.globals.DebugLevel.message ( )

Get the string representing the debug level of this enumerated DebugLevel instance.

Return: the debug level message