GAMSExecutionException contains the exit code unsuccessfully returned by GAMS process.
More...
Public Member Functions | |
| GAMSExecutionException (int code) | |
| Constructs a new GAMSExecutionException with the specified exit code. | |
| GAMSExecutionException (int code, GAMSWorkspace ws) | |
| Constructs a new GAMSExecutionException with the specified exit code. | |
| GAMSExecutionException (int code, String msg) | |
| Constructs a new GAMSExecutionException with the specified exit code. | |
| GAMSExecutionException (int code, String msg, GAMSWorkspace ws) | |
| Constructs a new GAMSExecutionException with the specified exit code. | |
| int | getExitCode () |
| Get the error exit code returned by executing GAMS process. | |
| String | getExitCodeString () |
| Get the string describing the error exit code returned by GAMS process. | |
| String | getMessage () |
| Returns the detailed message of this GAMSExecutionException. | |
 Public Member Functions inherited from com.gams.api.GAMSException | |
| GAMSException () | |
| Constructs a new GAMSException. | |
| GAMSException (String message) | |
| Constructs a new GAMSException with the specified detail message. | |
| String | getMessage () |
| Returns the detailed message string of this GAMSException. | |
Detailed Description
GAMSExecutionException contains the exit code unsuccessfully returned by GAMS process.
For instance, within GAMSJob.run method,
this exception will be thrown if GAMS process terminates with an error (exit code that is not '0').
GAMSExecutionException extends GAMSException which subclasses Java Runtime Exception; therefore, it can be thrown during the normal operation of the Java Virtual Machine.
- See also
- GAMSGlobals.ExitCodeMessage
Constructor & Destructor Documentation
◆ GAMSExecutionException() [1/4]
| com.gams.api.GAMSExecutionException.GAMSExecutionException | ( | int | code | ) |
Constructs a new GAMSExecutionException with the specified exit code.
- Parameters
-
code exit code
◆ GAMSExecutionException() [2/4]
| com.gams.api.GAMSExecutionException.GAMSExecutionException | ( | int | code, |
| GAMSWorkspace | ws | ||
| ) |
Constructs a new GAMSExecutionException with the specified exit code.
- Parameters
-
code exit code ws active workspace
◆ GAMSExecutionException() [3/4]
| com.gams.api.GAMSExecutionException.GAMSExecutionException | ( | int | code, |
| String | msg | ||
| ) |
Constructs a new GAMSExecutionException with the specified exit code.
- Parameters
-
code exit code msg the detailed message
◆ GAMSExecutionException() [4/4]
| com.gams.api.GAMSExecutionException.GAMSExecutionException | ( | int | code, |
| String | msg, | ||
| GAMSWorkspace | ws | ||
| ) |
Constructs a new GAMSExecutionException with the specified exit code.
- Parameters
-
code exit code msg the detailed message ws active workspace
Member Function Documentation
◆ getExitCode()
| int com.gams.api.GAMSExecutionException.getExitCode | ( | ) |
Get the error exit code returned by executing GAMS process.
- Returns
- the int value of the exit code.
- See also
- GAMSGlobals.ExitCodeMessage
◆ getExitCodeString()
| String com.gams.api.GAMSExecutionException.getExitCodeString | ( | ) |
Get the string describing the error exit code returned by GAMS process.
- Returns
- the string describing the exit code
- See also
- GAMSGlobals.ExitCodeMessage
◆ getMessage()
| String com.gams.api.GAMSExecutionException.getMessage | ( | ) |
Returns the detailed message of this GAMSExecutionException.
- Returns
- the detailed message of this GAMSExecutionException instance.
- See also
- GAMSGlobals.ExitCodeMessage
Reimplemented from com.gams.api.GAMSException.