Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Matlab.GAMS.DebugLevel Enum 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.
 
integer value ()
 Returns alternative value of enum option.
 

Static Public Member Functions

static DebugLevel lookup (varargin)
 Find enum option from alternative value.
 

Public Attributes

 KEEP_FILES =(1)
 Keep temporary files, string representation "keepfiles".
 
 OFF =(0)
 No Debug, string representation "off".
 
 SHOW_LOG =(2)
 Send GAMS log to standard output and keep temporary files, string representation "showlog".
 
 UNDEFINED_LEVEL =(4)
 Undefined option, string representation "undefined".
 
 VERBOSE =(3)
 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 GAMSWorkspace 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 GAMSWorkspaceInfo instance or a String instance parameter of a GAMSWorkspace constructor.

See also
GAMSWorkspace, GAMSWorkspaceInfo

Member Function Documentation

◆ equals()

logical Matlab.GAMS.DebugLevel.equals ( varargin  )

Compare if the parameter is of the same DebugLevel.

Arguments:

  • another: GAMS data type

◆ isHigherThan()

logical Matlab.GAMS.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.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

◆ lookup()

static DebugLevel Matlab.GAMS.DebugLevel.lookup ( varargin  )
static

Find enum option from alternative value.

Valid VARARGIN signatures:

  • integer value
  • string value

Arguments:

  • value: Alternative value

Return: enum option

◆ message()

string Matlab.GAMS.DebugLevel.message ( )

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

Return: the debug level message

◆ value()

integer Matlab.GAMS.DebugLevel.value ( )

Returns alternative value of enum option.

Return: Alternative value of enum option