apis/cpp/gamsenum_8h_source.html

#ifndef GAMSENUM_H

#define GAMSENUM_H

// TODO(jm) generator-change-request: #pragma once in some cases behaves differently to standard IFDEF guard

// TODO(JM) generator-change-request: XML-Tags in comments -> no c++ style

// TODO(JM) generator-change-request: add static functions to get enums as string


#include <string>

#include "gamslib_global.h" // LIBSPEC


namespace gams {


class LIBSPEC GAMSEnum

{

public:


    enum SymbolType

    {

        SymTypeSet = 0,

        SymTypePar,

        SymTypeVar,

        SymTypeEqu

    };

    enum SymbolType {…};


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


    // TODO(AF) difference gmomcc.h/gmoEquType(=> B) and gclgms.h/GMS_EQUTYPE_MAX(=> MAX)?


    enum EquType

    {

        E = 0,

        G = 1,

        L = 2,

        N = 3,

        X = 4,

        C = 5,

        MAX = 6

    };

    enum EquType {…};


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


    enum SetType

    {

        Multi,

        Singleton

    };

    enum SetType {…};


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


    enum VarType

    {

        Unknown,

        Binary,

        Integer,

        Positive,

        Negative,

        Free,

        SOS1,

        SOS2,

        SemiCont,

        SemiInt

    };

    enum VarType {…};


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


    enum SolveStat

    {

        Normal = 1,

        Iteration,

        Resource,

        Solver,

        EvalError,

        Capability,

        License,

        User,

        SetupErr,

        SolverErr,

        InternalErr,

        Skipped,

        SystemErr

    };

    enum SolveStat {…};


    enum ModelStat

    {

        OptimalGlobal = 1,

        OptimalLocal,

        Unbounded,

        InfeasibleGlobal,

        InfeasibleLocal,

        InfeasibleIntermed,

        Feasible,

        IntegerSolution,

        NonIntegerIntermed,

        IntegerInfeasible,

        LicenseError,

        ErrorUnknown,

        ErrorNoSolution,

        NoSolutionReturned,

        SolvedUnique,

        Solved,

        SolvedSingular,

        UnboundedNoSolution,

        InfeasibleNoSolution

    };

    enum ModelStat {…};


    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

    };

    enum GAMSExitCode {…};


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


    enum SymbolUpdateAction

    {

        Param = 0,

        Upper = 1,

        Lower = 2,

        Fixed = 3,

        Primal = 4,

        Dual = 5

    };

    enum SymbolUpdateAction {…};


    enum DebugLevel

    {

        Off = 0,

        KeepFilesOnError,

        KeepFiles,

        ShowLog,

        Verbose

    };

    enum DebugLevel {…};


    enum SymbolUpdateType

    {

        Default = 0,

        BaseCase = 1,

        Accumulate = 2,


        Inherit = 3

        //                   // TODO(AF): this is not part of the C API (gmdUpdateType)!

    };

    enum SymbolUpdateType {…};


    enum EAction

    {

        RestartAfterSolve = 0,

        CompileOnly,

        ExecuteOnly,

        CompileAndExecute,

        GlueCodeGeneration,

        TraceReport

    };

    enum EAction {…};


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


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


    static EAction eActionFromCode(std::string str);


};

class LIBSPEC GAMSEnum {…};


}

#endif // GAMSENUM_H

gams::GAMSEnum
The collection of all common GAMS enumerations.
Definition gamsenum.h:39

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

gams::GAMSEnum::VarType
VarType
Variable subtype.
Definition gamsenum.h:83

gams::GAMSEnum::Negative
@ Negative
Negative variable.
Definition gamsenum.h:88

gams::GAMSEnum::Free
@ Free
Free variable.
Definition gamsenum.h:89

gams::GAMSEnum::Unknown
@ Unknown
Unknown variable type.
Definition gamsenum.h:84

gams::GAMSEnum::SemiCont
@ SemiCont
Semi-continuous variable.
Definition gamsenum.h:92

gams::GAMSEnum::Positive
@ Positive
Positive variable.
Definition gamsenum.h:87

gams::GAMSEnum::Integer
@ Integer
Integer Variable.
Definition gamsenum.h:86

gams::GAMSEnum::SOS1
@ SOS1
Special Ordered Set 1.
Definition gamsenum.h:90

gams::GAMSEnum::SOS2
@ SOS2
Special Ordered Set 2.
Definition gamsenum.h:91

gams::GAMSEnum::Binary
@ Binary
Binary variable.
Definition gamsenum.h:85

gams::GAMSEnum::DebugLevel
DebugLevel
GAMS Debug Level.
Definition gamsenum.h:198

gams::GAMSEnum::KeepFilesOnError
@ KeepFilesOnError
Keep temporary files only if GamsExceptionExecution was raised in GamsJob.run() or GamsJob....
Definition gamsenum.h:200

gams::GAMSEnum::KeepFiles
@ KeepFiles
Keep temporary files.
Definition gamsenum.h:201

gams::GAMSEnum::ShowLog
@ ShowLog
Send GAMS log to stdout and keep temporary files.
Definition gamsenum.h:202

gams::GAMSEnum::EquType
EquType
Equation subtype.
Definition gamsenum.h:58

gams::GAMSEnum::eActionFromCode
static EAction eActionFromCode(std::string str)
Get a GAMSEnum::EAction from a std::string.

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

gams::GAMSEnum::text
static std::string text(GAMSEnum::SymbolType type)
Get a GAMSEnum::SymbolType as string.

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

gams::GAMSEnum::GAMSExitCode
GAMSExitCode
GAMS exit code.
Definition gamsenum.h:143

gams::GAMSEnum::ExecutionError
@ ExecutionError
There was an execution error.
Definition gamsenum.h:147

gams::GAMSEnum::CompilationError
@ CompilationError
There was a compilation error.
Definition gamsenum.h:146

gams::GAMSEnum::GAMSSystemError
@ GAMSSystemError
There was a GAMS system error.
Definition gamsenum.h:152

gams::GAMSEnum::OutOfMemory
@ OutOfMemory
Out of memory.
Definition gamsenum.h:154

gams::GAMSEnum::FileError
@ FileError
There was a file error.
Definition gamsenum.h:149

gams::GAMSEnum::ParameterError
@ ParameterError
There was a parameter error.
Definition gamsenum.h:150

gams::GAMSEnum::GAMSCouldNotBeStarted
@ GAMSCouldNotBeStarted
GAMS cold not be started.
Definition gamsenum.h:153

gams::GAMSEnum::SolverToBeCalled
@ SolverToBeCalled
Solver is to be called, the system should never return this number.
Definition gamsenum.h:145

gams::GAMSEnum::SystemLimitsReached
@ SystemLimitsReached
System limits were reached.
Definition gamsenum.h:148

gams::GAMSEnum::LicensingError
@ LicensingError
There was a licensing error.
Definition gamsenum.h:151

gams::GAMSEnum::OutOfDisk
@ OutOfDisk
Out of disk.
Definition gamsenum.h:155

gams::GAMSEnum::SymbolUpdateType
SymbolUpdateType
Symbol update type.
Definition gamsenum.h:208

gams::GAMSEnum::EAction
EAction
GAMS processing requests.
Definition gamsenum.h:219

gams::GAMSEnum::CompileAndExecute
@ CompileAndExecute
Compile and Execute.
Definition gamsenum.h:223

gams::GAMSEnum::CompileOnly
@ CompileOnly
CompileOnly.
Definition gamsenum.h:221

gams::GAMSEnum::ExecuteOnly
@ ExecuteOnly
ExecuteOnly.
Definition gamsenum.h:222

gams::GAMSEnum::GlueCodeGeneration
@ GlueCodeGeneration
Glue Code Generation.
Definition gamsenum.h:224

gams::GAMSEnum::SetType
SetType
Set subtype.
Definition gamsenum.h:73

gams::GAMSEnum::Multi
@ Multi
Multi Set - default.
Definition gamsenum.h:74

gams::GAMSEnum::ModelStat
ModelStat
Model Solution Status.
Definition gamsenum.h:119

gams::GAMSEnum::Unbounded
@ Unbounded
Unbounded model found.
Definition gamsenum.h:122

gams::GAMSEnum::IntegerInfeasible
@ IntegerInfeasible
No feasible integer solution could be found.
Definition gamsenum.h:129

gams::GAMSEnum::NoSolutionReturned
@ NoSolutionReturned
No solution returned.
Definition gamsenum.h:133

gams::GAMSEnum::InfeasibleGlobal
@ InfeasibleGlobal
Infeasible model found.
Definition gamsenum.h:123

gams::GAMSEnum::OptimalLocal
@ OptimalLocal
Local optimal solution achieved.
Definition gamsenum.h:121

gams::GAMSEnum::LicenseError
@ LicenseError
Licensing problem.
Definition gamsenum.h:130

gams::GAMSEnum::IntegerSolution
@ IntegerSolution
Integer solution found.
Definition gamsenum.h:127

gams::GAMSEnum::InfeasibleIntermed
@ InfeasibleIntermed
Solver terminated early and model was still infeasible.
Definition gamsenum.h:125

gams::GAMSEnum::SolvedUnique
@ SolvedUnique
Unique solution in a CNS models.
Definition gamsenum.h:134

gams::GAMSEnum::InfeasibleLocal
@ InfeasibleLocal
Locally infeasible model found.
Definition gamsenum.h:124

gams::GAMSEnum::Solved
@ Solved
Feasible solution in a CNS models.
Definition gamsenum.h:135

gams::GAMSEnum::Feasible
@ Feasible
Feasible solution.
Definition gamsenum.h:126

gams::GAMSEnum::ErrorUnknown
@ ErrorUnknown
Error - No cause known.
Definition gamsenum.h:131

gams::GAMSEnum::ErrorNoSolution
@ ErrorNoSolution
Error - No solution attained.
Definition gamsenum.h:132

gams::GAMSEnum::NonIntegerIntermed
@ NonIntegerIntermed
Solver terminated early with a non integer solution found.
Definition gamsenum.h:128

gams::GAMSEnum::SolvedSingular
@ SolvedSingular
Singular in a CNS models.
Definition gamsenum.h:136

gams::GAMSEnum::UnboundedNoSolution
@ UnboundedNoSolution
Unbounded - no solution.
Definition gamsenum.h:137

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

gams::GAMSEnum::SymbolType
SymbolType
This enum defines the type of a symbol (The type Alias is not supported and shows as Set).
Definition gamsenum.h:44

gams::GAMSEnum::SymTypeVar
@ SymTypeVar
Symbol type is a Variable.
Definition gamsenum.h:47

gams::GAMSEnum::SymTypePar
@ SymTypePar
Symbol type is a Parameter.
Definition gamsenum.h:46

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

gams::GAMSEnum::SymbolUpdateAction
SymbolUpdateAction
What field to update.
Definition gamsenum.h:187

gams::GAMSEnum::SolveStat
SolveStat
Solver termination condition.
Definition gamsenum.h:101

gams::GAMSEnum::License
@ License
Solver terminated with a license error.
Definition gamsenum.h:108

gams::GAMSEnum::InternalErr
@ InternalErr
Solver terminated with error.
Definition gamsenum.h:112

gams::GAMSEnum::Iteration
@ Iteration
Solver ran out of iterations.
Definition gamsenum.h:103

gams::GAMSEnum::Resource
@ Resource
Solver exceeded time limit.
Definition gamsenum.h:104

gams::GAMSEnum::Skipped
@ Skipped
Solve skipped.
Definition gamsenum.h:113

gams::GAMSEnum::SetupErr
@ SetupErr
Solver terminated on setup error.
Definition gamsenum.h:110

gams::GAMSEnum::EvalError
@ EvalError
Solver quit with nonlinear term evaluation errors.
Definition gamsenum.h:106

gams::GAMSEnum::User
@ User
Solver terminated on users request (e.g. Ctrl-C)
Definition gamsenum.h:109

gams::GAMSEnum::Solver
@ Solver
Solver quit with a problem.
Definition gamsenum.h:105

gams::GAMSEnum::SolverErr
@ SolverErr
Solver terminated with error.
Definition gamsenum.h:111

gams::GAMSEnum::Capability
@ Capability
Solver terminated because the model is beyond the solvers capabilities.
Definition gamsenum.h:107

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

gams
Definition gams.h:91