The collection of all common GAMS enumerations. More...

#include <gamsenum.h>

Public Types
enum	SymbolType { SymTypeSet = 0 , SymTypePar , SymTypeVar , SymTypeEqu }
	This enum defines the type of a symbol (The type Alias is not supported and shows as Set). More...

enum	EquType { E = 0 , G = 1 , L = 2 , N = 3 , X = 4 , C = 5 , MAX = 6 }
	Equation subtype. More...

enum	SetType { Multi , Singleton }
	Set subtype. More...

enum	VarType { Unknown , Binary , Integer , Positive , Negative , Free , SOS1 , SOS2 , SemiCont , SemiInt }
	Variable subtype. More...

enum	SolveStat { Normal = 1 , Iteration , Resource , Solver , EvalError , Capability , License , User , SetupErr , SolverErr , InternalErr , Skipped , SystemErr }
	Solver termination condition. More...

enum	ModelStat { OptimalGlobal = 1 , OptimalLocal , Unbounded , InfeasibleGlobal , InfeasibleLocal , InfeasibleIntermed , Feasible , IntegerSolution , NonIntegerIntermed , IntegerInfeasible , LicenseError , ErrorUnknown , ErrorNoSolution , NoSolutionReturned , SolvedUnique , Solved , SolvedSingular , UnboundedNoSolution , InfeasibleNoSolution }
	Model Solution Status. More...

enum	GAMSExitCode { NormalReturn = 0 , SolverToBeCalled , CompilationError , ExecutionError , SystemLimitsReached , FileError , ParameterError , LicensingError , GAMSSystemError , GAMSCouldNotBeStarted , OutOfMemory , OutOfDisk , CouldNotCreateScratchDir = 109 , TooManyScratchDirs = 110 , CouldNotDeleteScratchDir = 112 , CouldNotWriteGamsNext = 113 , CouldNotWriteParamFile = 114 , CouldNotReadEnvVar = 115 , CouldNotSpawnGAMScmex = 400 , CurDirNotFound = 401 , CurDirNotSet = 402 , BlankInSysDir = 404 , BlankInCurDir = 405 , BlankInScrExt = 406 , UnexpectedCmexRC = 407 , ProcDirNotFound = 408 , CmexLibNotFound = 409 , CmexLibEPNotFound = 410 , BlankInProcDir = 411 , BlankInScrDir = 412 , CannotAddPath = 909 , MissingCommandLineParameter = 1000 , CannotInstallInterrupt = 2000 , CouldNotGetCurrentDir = 3000 , CmexNotFound = 4000 , OptNotFound = 5000 }
	GAMS exit code. More...

enum	SymbolUpdateAction { Param = 0 , Upper = 1 , Lower = 2 , Fixed = 3 , Primal = 4 , Dual = 5 }
	What field to update. More...

enum	DebugLevel { Off = 0 , KeepFilesOnError , KeepFiles , ShowLog , Verbose }
	GAMS Debug Level. More...

enum	SymbolUpdateType { Default = 0 , BaseCase = 1 , Accumulate = 2 , Inherit = 3 }
	Symbol update type. More...

enum	EAction { RestartAfterSolve = 0 , CompileOnly , ExecuteOnly , CompileAndExecute , GlueCodeGeneration , TraceReport }
	GAMS processing requests. More...

Static Public Member Functions
static std::string	text (GAMSEnum::SymbolType type)
	Get a `GAMSEnum::SymbolType` as string.

static std::string	text (GAMSEnum::EquType type)
	Get a `GAMSEnum::EquType` as string.

static std::string	text (GAMSEnum::SetType type)
	Get a `GAMSEnum::SetType` as string.

static std::string	text (GAMSEnum::VarType type)
	Get a `GAMSEnum::VarType` as string.

static std::string	text (GAMSEnum::GAMSExitCode type)
	Get a `GAMSEnum::GAMSExitCode` as text.

static std::string	text (GAMSEnum::EAction type)
	Get a `GAMSEnum::EAction` as text.

static std::string	code (GAMSEnum::EAction type)
	Get a `GAMSEnum::EAction` as code.

static EAction	eActionFromCode (const std::string &str)
	Get a `GAMSEnum::EAction` from a `std::string`.

Detailed Description

The collection of all common GAMS enumerations.

Definition at line 38 of file gamsenum.h.

Member Enumeration Documentation

◆ DebugLevel

enum gams::GAMSEnum::DebugLevel

GAMS Debug Level.

Enumerator
Off	No Debug.
KeepFilesOnError	Keep temporary files only if GamsExceptionExecution was raised in GamsJob.run() or GamsJob.run_engine()
KeepFiles	Keep temporary files.
ShowLog	Send GAMS log to stdout and keep temporary files.
Verbose	Send highly technical info and GAMS log to stdout and keep temporary file.

Definition at line 197 of file gamsenum.h.

◆ EAction

enum gams::GAMSEnum::EAction

GAMS processing requests.

Enumerator
RestartAfterSolve	Restart After Solve.
CompileOnly	CompileOnly.
ExecuteOnly	ExecuteOnly.
CompileAndExecute	Compile and Execute.
GlueCodeGeneration	Glue Code Generation.
TraceReport	Trace Report.

Definition at line 218 of file gamsenum.h.

◆ EquType

enum gams::GAMSEnum::EquType

Equation subtype.

Enumerator
E	Equality - =E=.
G	Greater or equal than inequality - =G=.
L	Less or equal than inequality - =L=.
N	Non-binding equation - =N=.
X	External equation - =X=.
C	Cone equation - =C=.

Definition at line 57 of file gamsenum.h.

◆ GAMSExitCode

enum gams::GAMSEnum::GAMSExitCode

GAMS exit code.

Enumerator
NormalReturn	Normal Return.
SolverToBeCalled	Solver is to be called, the system should never return this number.
CompilationError	There was a compilation error.
ExecutionError	There was an execution error.
SystemLimitsReached	System limits were reached.
FileError	There was a file error.
ParameterError	There was a parameter error.
LicensingError	There was a licensing error.
GAMSSystemError	There was a GAMS system error.
GAMSCouldNotBeStarted	GAMS cold not be started.
OutOfMemory	Out of memory.
OutOfDisk	Out of disk.
CouldNotCreateScratchDir	Could not create process/scratch directory.
TooManyScratchDirs	Too many process/scratch directories.
CouldNotDeleteScratchDir	Could not delete process/scratch directory.
CouldNotWriteGamsNext	Could not write the "gamsnext" script.
CouldNotWriteParamFile	Could not write the "parameter" file.
CouldNotReadEnvVar	Could not read environment variable.
CouldNotSpawnGAMScmex	Could not spawn the GAMS language compiler (gamscmex)
CurDirNotFound	Current directory (curdir) does not exist.
CurDirNotSet	Cannot set current directory (curdir)
BlankInSysDir	Blank in system directory (UNIX only)
BlankInCurDir	Blank in current directory (UNIX only)
BlankInScrExt	Blank in scratch extension (scrext)
UnexpectedCmexRC	Unexpected cmexRC.
ProcDirNotFound	Could not find the process directory (procdir)
CmexLibNotFound	CMEX library not found (experimental)
CmexLibEPNotFound	Entry point in CMEX library not found (experimental)
BlankInProcDir	Blank in process directory (UNIX only)
BlankInScrDir	Blank in scratch directory (UNIX only)
CannotAddPath	Cannot add path / Unknown UNIX environment / Cannot set environment variable.
MissingCommandLineParameter	Driver error: Missing command line parameter for gams.exe.
CannotInstallInterrupt	Driver error: Internal error: Cannot install interrupt handler.
CouldNotGetCurrentDir	Driver error: Problems getting current directory (sometimes caused by specifying the current directory in Microsoft UNC format)
CmexNotFound	Driver error: Internal error: GAMS compile and execute module not found.
OptNotFound	Driver error: Internal error: Cannot load option handling library.

Definition at line 142 of file gamsenum.h.

◆ ModelStat

enum gams::GAMSEnum::ModelStat

Model Solution Status.

Enumerator
OptimalGlobal	Optimal solution achieved.
OptimalLocal	Local optimal solution achieved.
Unbounded	Unbounded model found.
InfeasibleGlobal	Infeasible model found.
InfeasibleLocal	Locally infeasible model found.
InfeasibleIntermed	Solver terminated early and model was still infeasible.
Feasible	Feasible solution.
IntegerSolution	Integer solution found.
NonIntegerIntermed	Solver terminated early with a non integer solution found.
IntegerInfeasible	No feasible integer solution could be found.
LicenseError	Licensing problem.
ErrorUnknown	Error - No cause known.
ErrorNoSolution	Error - No solution attained.
NoSolutionReturned	No solution returned.
SolvedUnique	Unique solution in a CNS models.
Solved	Feasible solution in a CNS models.
SolvedSingular	Singular in a CNS models.
UnboundedNoSolution	Unbounded - no solution.
InfeasibleNoSolution	Infeasible - no solution.

Definition at line 118 of file gamsenum.h.

◆ SetType

enum gams::GAMSEnum::SetType

Set subtype.

Enumerator
Multi	Multi Set - default.
Singleton	Singleton Set - Zero or one element.

Definition at line 72 of file gamsenum.h.

◆ SolveStat

enum gams::GAMSEnum::SolveStat

Solver termination condition.

Enumerator
Normal	Normal termination.
Iteration	Solver ran out of iterations.
Resource	Solver exceeded time limit.
Solver	Solver quit with a problem.
EvalError	Solver quit with nonlinear term evaluation errors.
Capability	Solver terminated because the model is beyond the solvers capabilities.
License	Solver terminated with a license error.
User	Solver terminated on users request (e.g. Ctrl-C)
SetupErr	Solver terminated on setup error.
SolverErr	Solver terminated with error.
InternalErr	Solver terminated with error.
Skipped	Solve skipped.
SystemErr	Other error.

Definition at line 100 of file gamsenum.h.

◆ SymbolType

enum gams::GAMSEnum::SymbolType

This enum defines the type of a symbol (The type Alias is not supported and shows as Set).

Enumerator
SymTypeSet	Symbol type is a Set (or an Alias)
SymTypePar	Symbol type is a Parameter.
SymTypeVar	Symbol type is a Variable.
SymTypeEqu	Symbol type is a Equation.

Definition at line 43 of file gamsenum.h.

◆ SymbolUpdateAction

enum gams::GAMSEnum::SymbolUpdateAction

What field to update.

Enumerator
Param	Supplies paramter value.
Upper	Supplies upper bounds for a variable.
Lower	Supplies lower bounds for a variable.
Fixed	Supplies fixed bounds for a variable.
Primal	Supplies level for a variable or equation.
Dual	Supplies marginal for a variable or equation.

Definition at line 186 of file gamsenum.h.

◆ SymbolUpdateType

enum gams::GAMSEnum::SymbolUpdateType

Symbol update type.

Enumerator
Default	If record does not exist use 0 (Zero)
BaseCase	If record does not exist use values from instantiation.
Accumulate	If record does not exist use value from previous solve.
Inherit	Inherit setting from solve statement.

Definition at line 207 of file gamsenum.h.

◆ VarType

enum gams::GAMSEnum::VarType

Variable subtype.

Enumerator
Unknown	Unknown variable type.
Binary	Binary variable.
Integer	Integer Variable.
Positive	Positive variable.
Negative	Negative variable.
Free	Free variable.
SOS1	Special Ordered Set 1.
SOS2	Special Ordered Set 2.
SemiCont	Semi-continuous variable.
SemiInt	Semi-integer variable.

Definition at line 82 of file gamsenum.h.

Member Function Documentation

◆ code()

static std::string gams::GAMSEnum::code ( GAMSEnum::EAction type )

static

Get a GAMSEnum::EAction as code.

◆ eActionFromCode()

static EAction gams::GAMSEnum::eActionFromCode ( const std::string & str )

static

Get a GAMSEnum::EAction from a std::string.

◆ text() [1/6]

static std::string gams::GAMSEnum::text ( GAMSEnum::EAction type )

static

Get a GAMSEnum::EAction as text.

◆ text() [2/6]

static std::string gams::GAMSEnum::text ( GAMSEnum::EquType type )

static

Get a GAMSEnum::EquType as string.

◆ text() [3/6]

static std::string gams::GAMSEnum::text ( GAMSEnum::GAMSExitCode type )

static

Get a GAMSEnum::GAMSExitCode as text.

◆ text() [4/6]

static std::string gams::GAMSEnum::text ( GAMSEnum::SetType type )

static

Get a GAMSEnum::SetType as string.

◆ text() [5/6]

static std::string gams::GAMSEnum::text ( GAMSEnum::SymbolType type )

static

Get a GAMSEnum::SymbolType as string.

◆ text() [6/6]

static std::string gams::GAMSEnum::text ( GAMSEnum::VarType type )

static

Get a GAMSEnum::VarType as string.

Public Types

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ DebugLevel

◆ EAction

◆ EquType

◆ GAMSExitCode

◆ ModelStat

◆ SetType

◆ SolveStat

◆ SymbolType

◆ SymbolUpdateAction

◆ SymbolUpdateType

◆ VarType

Member Function Documentation

◆ code()

◆ eActionFromCode()

◆ text() [1/6]

◆ text() [2/6]

◆ text() [3/6]

◆ text() [4/6]

◆ text() [5/6]

◆ text() [6/6]