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
}
 Equation 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, 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 { , KeepFiles, ShowLog, Verbose }
 GAMS Debug Level. More...
 
enum  SymbolUpdateType { , 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. More...
 
static std::string text (GAMSEnum::EquType type)
 Get a GAMSEnum::EquType as string. More...
 
static std::string text (GAMSEnum::VarType type)
 Get a GAMSEnum::VarType as string. More...
 
static std::string text (GAMSEnum::GAMSExitCode type)
 Get a GAMSEnum::GAMSExitCode as text. More...
 
static std::string text (GAMSEnum::EAction type)
 Get a GAMSEnum::EAction as text. More...
 
static std::string code (GAMSEnum::EAction type)
 Get a GAMSEnum::EAction as code. More...
 
static EAction eActionFromCode (std::string str)
 Get a GAMSEnum::EAction from a std::string. More...
 

Detailed Description

The collection of all common GAMS enumerations.

Definition at line 38 of file gamsenum.h.

Member Enumeration Documentation

◆ DebugLevel

GAMS Debug Level.

Enumerator
KeepFiles 

No Debug.

ShowLog 

Keep temporary files.

Verbose 

Send GAMS log to stdout and keep temporary files.

Send highly technical info and GAMS log to stdout and keep temporary file

Definition at line 186 of file gamsenum.h.

◆ 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 206 of file gamsenum.h.

◆ EquType

Equation subtype.

Enumerator

Equality - =E=.

Greater or equal than inequality - =G=.

Less or equal than inequality - =L=.

Non-binding equation - =N=.

External equation - =X=.

Cone equation - =C=.

Definition at line 57 of file gamsenum.h.

◆ 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.

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 132 of file gamsenum.h.

◆ 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 108 of file gamsenum.h.

◆ 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 90 of file gamsenum.h.

◆ 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

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 175 of file gamsenum.h.

◆ SymbolUpdateType

Symbol update type.

Enumerator
BaseCase 

If record does not exist use 0 (Zero)

Accumulate 

If record does not exist use values from instantiation.

Inherit 

If record does not exist use value from previous solve.

Definition at line 195 of file gamsenum.h.

◆ 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 72 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 ( std::string  str)
static

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

◆ text() [1/5]

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

Get a GAMSEnum::SymbolType as string.

◆ text() [2/5]

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

Get a GAMSEnum::EquType as string.

◆ text() [3/5]

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

Get a GAMSEnum::VarType as string.

◆ text() [4/5]

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

Get a GAMSEnum::GAMSExitCode as text.

◆ text() [5/5]

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

Get a GAMSEnum::EAction as text.