Define GAMS Debug Level of different values and string representations. More...
Public Member Functions | |
| boolean | equals (DebugLevel level) |
| Compare if the parameter is of the same debug level. | |
| boolean | isLowerThan (DebugLevel level) |
| Compare if this debug level has lower level than the parameter. | |
| boolean | isHigherThan (DebugLevel level) |
| Compare if this debug level has higher level than the parameter. | |
| int | value () |
| Get the int value of this enumerated DebugLevel. | |
| String | message () |
| Get the string representing the debug level of this enumerated DebugLevel instance. | |
Static Public Member Functions | |
| static DebugLevel | lookup (int value) |
| Lookup all debug levels. | |
| static DebugLevel | lookup (String value) |
| Lookup all debug level messages. | |
Public Attributes | |
| OFF =("off") | |
| = 0 with string representation "off", No Debug | |
| KEEP_FILES_ON_ERROR =("keepFilesOnError") | |
| = 1 with string representation "keepfiles", Keep temporary files only in case of an error/exception | |
| KEEP_FILES =("keepfiles") | |
| = 2 with string representation "keepfiles", Keep temporary files | |
| SHOW_LOG =("showlog") | |
| = 3 with string representation "showlog", Send GAMS log to standard output and keep temporary files | |
| VERBOSE =("verbose") | |
| = 4 with string representation "verbose", Send highly technical info and GAMS log to standard output and keep temporary file | |
| UNDEFINED_LEVEL =("undefined") | |
| >= 4 with string representation "undefined", Undefined variable type | |
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()
| boolean com.gams.api.GAMSGlobals.DebugLevel.equals | ( | DebugLevel | level | ) |
Compare if the parameter is of the same debug level.
- Parameters
-
level debug level
- Returns
- true if the parameter is of the same debug level, false otherwise.
◆ isHigherThan()
| boolean com.gams.api.GAMSGlobals.DebugLevel.isHigherThan | ( | DebugLevel | level | ) |
Compare if this debug level has higher level than the parameter.
- Parameters
-
level debug level
- Returns
- true if this debug level has higher level than the parameter, false otherwise.
◆ isLowerThan()
| boolean com.gams.api.GAMSGlobals.DebugLevel.isLowerThan | ( | DebugLevel | level | ) |
Compare if this debug level has lower level than the parameter.
- Parameters
-
level debug level
- Returns
- true if this debug level has lower level than the parameter, false otherwise.
◆ lookup() [1/2]
|
static |
Lookup all debug levels.
- Parameters
-
value an int value to lookup
- Returns
- the enumerated DebugLevel that has the specified value, or UNDEFINED_LEVEL if the specified value is not found.
◆ lookup() [2/2]
|
static |
Lookup all debug level messages.
- Parameters
-
value a String value to lookup
- Returns
- the enumerated DebugLevel that has the specified message, or UNDEFINED_LEVEL if the specified value is not found.
◆ message()
| String com.gams.api.GAMSGlobals.DebugLevel.message | ( | ) |
Get the string representing the debug level of this enumerated DebugLevel instance.
- Returns
- the debug level message
◆ value()
| int com.gams.api.GAMSGlobals.DebugLevel.value | ( | ) |
Get the int value of this enumerated DebugLevel.
- Returns
- the int value of the DebugLevel
Member Data Documentation
◆ KEEP_FILES
| com.gams.api.GAMSGlobals.DebugLevel.KEEP_FILES =("keepfiles") |
= 2 with string representation "keepfiles", Keep temporary files
◆ KEEP_FILES_ON_ERROR
| com.gams.api.GAMSGlobals.DebugLevel.KEEP_FILES_ON_ERROR =("keepFilesOnError") |
= 1 with string representation "keepfiles", Keep temporary files only in case of an error/exception
◆ OFF
| com.gams.api.GAMSGlobals.DebugLevel.OFF =("off") |
= 0 with string representation "off", No Debug
◆ SHOW_LOG
| com.gams.api.GAMSGlobals.DebugLevel.SHOW_LOG =("showlog") |
= 3 with string representation "showlog", Send GAMS log to standard output and keep temporary files
◆ UNDEFINED_LEVEL
| com.gams.api.GAMSGlobals.DebugLevel.UNDEFINED_LEVEL =("undefined") |
>= 4 with string representation "undefined", Undefined variable type
◆ VERBOSE
| com.gams.api.GAMSGlobals.DebugLevel.VERBOSE =("verbose") |
= 4 with string representation "verbose", Send highly technical info and GAMS log to standard output and keep temporary file