#include <gamsoptions.h>

Classes

struct  EAction
 GAMS processing request. More...
 
struct  EAppendExpand
 Expand file append option. More...
 
struct  EAppendOut
 Output file append option. More...
 
struct  EAsyncSolLst
 Print solution listing when asynchronous solve (Grid or Threads) is used. More...
 
struct  ECase
 Output case option for LST file. More...
 
struct  ECharSet
 Character set flag. More...
 
struct  EDFormat
 Date format. More...
 
struct  EDumpOpt
 Writes preprocessed input to the file input.dmp. More...
 
struct  EDumpParms
 GAMS parameter logging. More...
 
struct  EErrMsg
 Placing of compilation error messages. More...
 
struct  EExecMode
 Limits on external programs that are allowed to be executed. More...
 
struct  EFDOpt
 Options for finite differences. More...
 
struct  EFileCase
 Casing of new file names (put, gdx, ref etc.) More...
 
struct  EForceWork
 Force GAMS systems to process save files for example with an execution error. More...
 
struct  EgdxCompress
 Compression of generated GDX file. More...
 
struct  EgdxConvert
 Version of GDX files generated (for backward compatibility) More...
 
struct  EgdxUels
 Unload labels or UELs to GDX either squeezed or full. More...
 
struct  EHoldFixed
 Treat fixed variables as constants. More...
 
struct  EInteractiveSolver
 Allow solver to interact via command line input. More...
 
struct  EIntVarUp
 Set default upper bound on integer variables. More...
 
struct  EKeep
 Controls keeping or deletion of process directory and scratch files. More...
 
struct  ELogLine
 Amount of line tracing to the log file. More...
 
struct  ENoNewVarEqu
 Triggers a compilation error when new equations or variable symbols are introduced. More...
 
struct  EOn115
 Generate errors for unknown unique element in an equation. More...
 
struct  EPageContr
 Output file page control option. More...
 
struct  EPrefixLoadPath
 Prepend GAMS system directory to library load path. More...
 
struct  EPyMultInst
 GAMS/Python Multiple Instance Interpreter. More...
 
struct  EPySetup
 GAMS/Python Setup. More...
 
struct  ESavePoint
 Save solver point in GDX file. More...
 
struct  ESolPrint
 Solution report print option. More...
 
struct  ESolveLink
 Solver link option. More...
 
struct  EStepSum
 Summary of computing resources used by job steps. More...
 
struct  EstrictSingleton
 Error if assignment to singleton set has multiple elements. More...
 
struct  EStringChk
 String substitution options. More...
 
struct  ESuppress
 Compiler listing option. More...
 
struct  ESys10
 Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer. More...
 
struct  ESys11
 Dynamic resorting if indices in assignment/data statements are not in natural order. More...
 
struct  ESysOut
 Solver Status file reporting option. More...
 
struct  ETFormat
 Time format. More...
 
struct  ETraceOpt
 Trace file format option. More...
 
struct  EZeroResRep
 Report underflow as a warning when abs(results) LE ZeroRes and result set to zero. More...
 

Public Member Functions

 ~GAMSOptions ()
 Destructor. More...
 
LogId logID ()
 
void writeOptionFile (const std::string &optFileName)
 Export options to an option file. More...
 
void setAllModelTypes (const std::string &solver)
 Set the solver for all model types the solver can handle. More...
 
int inputDirSize ()
 Get the size of the inputdir list. More...
 
void addInputDir (const std::string value)
 Add new inputdir at the end of the inputdir list. More...
 
std::string getInputDir (const int index)
 Get an inputdir at position index of the inputdir list. More...
 
void setInputDir (const std::string value, const int index)
 Replace inputdir at the specified index of the inputdir list. More...
 
void removeInputDir (const int index)
 Remove an inputdir at position index of the inputdir list. More...
 
void setDefine (const std::string &key, const std::string &value)
 Set double-dash –key=value option pair. More...
 
std::string getDefine (const std::string &key)
 Get value of previously set double-dash –key-value option pair. More...
 
bool removeDefine (const std::string &key)
 Remove a double-dash option. More...
 
std::string gdx ()
 Get GDX file name. More...
 
void setGdx (const std::string &value)
 Set GDX file name. More...
 
std::string output ()
 Get Listing file name. More...
 
void setOutput (const std::string &value)
 Set Listing file name. More...
 
std::string symbol ()
 Get Symbol table file. More...
 
void setSymbol (const std::string &value)
 Set Symbol table file. More...
 
std::string expand ()
 Get Expanded (include) input file name. More...
 
void setExpand (const std::string &value)
 Set Expanded (include) input file name. More...
 
int pageWidth ()
 Get Output file page width. More...
 
void setPageWidth (const int value)
 Set Output file page width. More...
 
int pageSize ()
 Get Output file page size (=0 no paging) More...
 
void setPageSize (const int value)
 Set Output file page size (=0 no paging) More...
 
GAMSOptions::EPageContr::EPageContrEnum pageContr ()
 Get Output file page control option. More...
 
void setPageContr (const GAMSOptions::EPageContr::EPageContrEnum value)
 Set Output file page control option. More...
 
GAMSOptions::EAction::EActionEnum action ()
 Get GAMS processing request. More...
 
void setAction (const GAMSOptions::EAction::EActionEnum value)
 Set GAMS processing request. More...
 
std::string putDir ()
 Get Put file directory. More...
 
void setPutDir (const std::string &value)
 Set Put file directory. More...
 
std::string gridDir ()
 Get Grid file directory. More...
 
void setGridDir (const std::string &value)
 Set Grid file directory. More...
 
std::string scriptExit ()
 Get Program or script to be executed at the end of a GAMS run. More...
 
void setScriptExit (const std::string &value)
 Set Program or script to be executed at the end of a GAMS run. More...
 
GAMSOptions::ELogLine::ELogLineEnum logLine ()
 Get Amount of line tracing to the log file. More...
 
void setLogLine (const GAMSOptions::ELogLine::ELogLineEnum value)
 Set Amount of line tracing to the log file. More...
 
std::string trace ()
 Get Trace file name. More...
 
void setTrace (const std::string &value)
 Set Trace file name. More...
 
GAMSOptions::EAppendOut::EAppendOutEnum appendOut ()
 Get Output file append option. More...
 
void setAppendOut (const GAMSOptions::EAppendOut::EAppendOutEnum value)
 Set Output file append option. More...
 
GAMSOptions::EStepSum::EStepSumEnum stepSum ()
 Get Summary of computing resources used by job steps. More...
 
void setStepSum (const GAMSOptions::EStepSum::EStepSumEnum value)
 Set Summary of computing resources used by job steps. More...
 
GAMSOptions::ESuppress::ESuppressEnum suppress ()
 Get Compiler listing option. More...
 
void setSuppress (const GAMSOptions::ESuppress::ESuppressEnum value)
 Set Compiler listing option. More...
 
GAMSOptions::EDFormat::EDFormatEnum dFormat ()
 Get Date format. More...
 
void setDFormat (const GAMSOptions::EDFormat::EDFormatEnum value)
 Set Date format. More...
 
GAMSOptions::ETFormat::ETFormatEnum tFormat ()
 Get Time format. More...
 
void setTFormat (const GAMSOptions::ETFormat::ETFormatEnum value)
 Set Time format. More...
 
int tabIn ()
 Get Tab spacing. More...
 
void setTabIn (const int value)
 Set Tab spacing. More...
 
GAMSOptions::EIntVarUp::EIntVarUpEnum intVarUp ()
 Get Set default upper bound on integer variables. More...
 
void setIntVarUp (const GAMSOptions::EIntVarUp::EIntVarUpEnum value)
 Set Set default upper bound on integer variables. More...
 
int lstCase ()
 Get Output case option for LST file. More...
 
void setLstCase (const int value)
 Set Output case option for LST file. More...
 
std::string license ()
 Get Use alternative license file. More...
 
void setLicense (const std::string &value)
 Set Use alternative license file. More...
 
GAMSOptions::EDumpParms::EDumpParmsEnum dumpParms ()
 Get GAMS parameter logging. More...
 
void setDumpParms (const GAMSOptions::EDumpParms::EDumpParmsEnum value)
 Set GAMS parameter logging. More...
 
int profile ()
 Get Execution profiling. More...
 
void setProfile (const int value)
 Set Execution profiling. More...
 
std::string libIncDir ()
 Get LibInclude directory. More...
 
void setLibIncDir (const std::string &value)
 Set LibInclude directory. More...
 
std::string sysIncDir ()
 Get SysInclude directory. More...
 
void setSysIncDir (const std::string &value)
 Set SysInclude directory. More...
 
std::string user1 ()
 Get User string N. More...
 
void setUser1 (const std::string &value)
 Set User string N. More...
 
std::string user2 ()
 Get User string N. More...
 
void setUser2 (const std::string &value)
 Set User string N. More...
 
std::string user3 ()
 Get User string N. More...
 
void setUser3 (const std::string &value)
 Set User string N. More...
 
std::string user4 ()
 Get User string N. More...
 
void setUser4 (const std::string &value)
 Set User string N. More...
 
std::string user5 ()
 Get User string N. More...
 
void setUser5 (const std::string &value)
 Set User string N. More...
 
GAMSOptions::EForceWork::EForceWorkEnum forceWork ()
 Get Force GAMS systems to process save files for example with an execution error. More...
 
void setForceWork (const GAMSOptions::EForceWork::EForceWorkEnum value)
 Set Force GAMS systems to process save files for example with an execution error. More...
 
int cErr ()
 Get Compile time error limit. More...
 
void setCErr (const int value)
 Set Compile time error limit. More...
 
std::string fErr ()
 Get Alternative error message file. More...
 
void setFErr (const std::string &value)
 Set Alternative error message file. More...
 
int optFile ()
 Get Default option file. More...
 
void setOptFile (const int value)
 Set Default option file. More...
 
GAMSOptions::EDumpOpt::EDumpOptEnum dumpOpt ()
 Get Writes preprocessed input to the file input.dmp. More...
 
void setDumpOpt (const GAMSOptions::EDumpOpt::EDumpOptEnum value)
 Set Writes preprocessed input to the file input.dmp. More...
 
GAMSOptions::EErrMsg::EErrMsgEnum errMsg ()
 Get Placing of compilation error messages. More...
 
void setErrMsg (const GAMSOptions::EErrMsg::EErrMsgEnum value)
 Set Placing of compilation error messages. More...
 
GAMSOptions::EStringChk::EStringChkEnum stringChk ()
 Get String substitution options. More...
 
void setStringChk (const GAMSOptions::EStringChk::EStringChkEnum value)
 Set String substitution options. More...
 
std::string reference ()
 Get Symbol reference file. More...
 
void setReference (const std::string &value)
 Set Symbol reference file. More...
 
std::string optDir ()
 Get Option file directory. More...
 
void setOptDir (const std::string &value)
 Set Option file directory. More...
 
int execErr ()
 Get Execution time error limit. More...
 
void setExecErr (const int value)
 Set Execution time error limit. More...
 
int errorLog ()
 Get Max error message lines written to the log for each error. More...
 
void setErrorLog (const int value)
 Set Max error message lines written to the log for each error. More...
 
int limRow ()
 Get Maximum number of rows listed in one equation block. More...
 
void setLimRow (const int value)
 Set Maximum number of rows listed in one equation block. More...
 
int limCol ()
 Get Maximum number of columns listed in one variable block. More...
 
void setLimCol (const int value)
 Set Maximum number of columns listed in one variable block. More...
 
GAMSOptions::ECharSet::ECharSetEnum charSet ()
 Get Character set flag. More...
 
void setCharSet (const GAMSOptions::ECharSet::ECharSetEnum value)
 Set Character set flag. More...
 
GAMSOptions::EKeep::EKeepEnum keep ()
 Get Controls keeping or deletion of process directory and scratch files. More...
 
void setKeep (const GAMSOptions::EKeep::EKeepEnum value)
 Set Controls keeping or deletion of process directory and scratch files. More...
 
GAMSOptions::ETraceOpt::ETraceOptEnum traceOpt ()
 Get Trace file format option. More...
 
void setTraceOpt (const GAMSOptions::ETraceOpt::ETraceOptEnum value)
 Set Trace file format option. More...
 
int iterLim ()
 Get Iteration limit of solver. More...
 
void setIterLim (const int value)
 Set Iteration limit of solver. More...
 
int domLim ()
 Get Domain violation limit solver default. More...
 
void setDomLim (const int value)
 Set Domain violation limit solver default. More...
 
double resLim ()
 Get Wall-clock time limit for solver. More...
 
void setResLim (const double value)
 Set Wall-clock time limit for solver. More...
 
double optCR ()
 Get Relative Optimality criterion solver default. More...
 
void setOptCR (const double value)
 Set Relative Optimality criterion solver default. More...
 
double optCA ()
 Get Absolute Optimality criterion solver default. More...
 
void setOptCA (const double value)
 Set Absolute Optimality criterion solver default. More...
 
GAMSOptions::ESysOut::ESysOutEnum sysOut ()
 Get Solver Status file reporting option. More...
 
void setSysOut (const GAMSOptions::ESysOut::ESysOutEnum value)
 Set Solver Status file reporting option. More...
 
GAMSOptions::ESolPrint::ESolPrintEnum solPrint ()
 Get Solution report print option. More...
 
void setSolPrint (const GAMSOptions::ESolPrint::ESolPrintEnum value)
 Set Solution report print option. More...
 
double bratio ()
 Get Basis acceptance threshold. More...
 
void setBratio (const double value)
 Set Basis acceptance threshold. More...
 
GAMSOptions::EHoldFixed::EHoldFixedEnum holdFixed ()
 Get Treat fixed variables as constants. More...
 
void setHoldFixed (const GAMSOptions::EHoldFixed::EHoldFixedEnum value)
 Set Treat fixed variables as constants. More...
 
int nodLim ()
 Get Node limit in branch and bound tree. More...
 
void setNodLim (const int value)
 Set Node limit in branch and bound tree. More...
 
double workFactor ()
 Get Memory Estimate multiplier for some solvers. More...
 
void setWorkFactor (const double value)
 Set Memory Estimate multiplier for some solvers. More...
 
double workSpace ()
 Get Work space for some solvers in MB. More...
 
void setWorkSpace (const double value)
 Set Work space for some solvers in MB. More...
 
int forLim ()
 Get GAMS looping limit. More...
 
void setForLim (const int value)
 Set GAMS looping limit. More...
 
int seed ()
 Get Random number seed. More...
 
void setSeed (const int value)
 Set Random number seed. More...
 
GAMSOptions::EOn115::EOn115Enum on115 ()
 Get Generate errors for unknown unique element in an equation. More...
 
void setOn115 (const GAMSOptions::EOn115::EOn115Enum value)
 Set Generate errors for unknown unique element in an equation. More...
 
GAMSOptions::EExecMode::EExecModeEnum execMode ()
 Get Limits on external programs that are allowed to be executed. More...
 
void setExecMode (const GAMSOptions::EExecMode::EExecModeEnum value)
 Set Limits on external programs that are allowed to be executed. More...
 
GAMSOptions::EInteractiveSolver::EInteractiveSolverEnum interactiveSolver ()
 Get Allow solver to interact via command line input. More...
 
void setInteractiveSolver (const GAMSOptions::EInteractiveSolver::EInteractiveSolverEnum value)
 Set Allow solver to interact via command line input. More...
 
std::string pLicense ()
 Get Privacy license file name. More...
 
void setPLicense (const std::string &value)
 Set Privacy license file name. More...
 
std::string jobTrace ()
 Get Job trace string to be written to the trace file at the end of a GAMS job. More...
 
void setJobTrace (const std::string &value)
 Set Job trace string to be written to the trace file at the end of a GAMS job. More...
 
int warnings ()
 Get Number of warnings permitted before a run terminates. More...
 
void setWarnings (const int value)
 Set Number of warnings permitted before a run terminates. More...
 
int traceLevel ()
 Get Solvestat threshold used in conjunction with action=GT. More...
 
void setTraceLevel (const int value)
 Set Solvestat threshold used in conjunction with action=GT. More...
 
int timer ()
 Get Instruction timer threshold in milli seconds. More...
 
void setTimer (const int value)
 Set Instruction timer threshold in milli seconds. More...
 
GAMSOptions::EFileCase::EFileCaseEnum fileCase ()
 Get Casing of new file names (put, gdx, ref etc.) More...
 
void setFileCase (const GAMSOptions::EFileCase::EFileCaseEnum value)
 Set Casing of new file names (put, gdx, ref etc.) More...
 
GAMSOptions::ESavePoint::ESavePointEnum savePoint ()
 Get Save solver point in GDX file. More...
 
void setSavePoint (const GAMSOptions::ESavePoint::ESavePointEnum value)
 Set Save solver point in GDX file. More...
 
GAMSOptions::ESolveLink::ESolveLinkEnum solveLink ()
 Get Solver link option. More...
 
void setSolveLink (const GAMSOptions::ESolveLink::ESolveLinkEnum value)
 Set Solver link option. More...
 
GAMSOptions::ESys10::ESys10Enum sys10 ()
 Get Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer. More...
 
void setSys10 (const GAMSOptions::ESys10::ESys10Enum value)
 Set Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer. More...
 
GAMSOptions::ESys11::ESys11Enum sys11 ()
 Get Dynamic resorting if indices in assignment/data statements are not in natural order. More...
 
void setSys11 (const GAMSOptions::ESys11::ESys11Enum value)
 Set Dynamic resorting if indices in assignment/data statements are not in natural order. More...
 
int sys12 ()
 Get Pass model with generation errors to solver. More...
 
void setSys12 (const int value)
 Set Pass model with generation errors to solver. More...
 
double zeroRes ()
 Get The results of certain operations will be set to zero if abs(result) LE ZeroRes. More...
 
void setZeroRes (const double value)
 Set The results of certain operations will be set to zero if abs(result) LE ZeroRes. More...
 
GAMSOptions::EZeroResRep::EZeroResRepEnum zeroResRep ()
 Get Report underflow as a warning when abs(results) LE ZeroRes and result set to zero. More...
 
void setZeroResRep (const GAMSOptions::EZeroResRep::EZeroResRepEnum value)
 Set Report underflow as a warning when abs(results) LE ZeroRes and result set to zero. More...
 
double heapLimit ()
 Get Maximum Heap size allowed in MB. More...
 
void setHeapLimit (const double value)
 Set Maximum Heap size allowed in MB. More...
 
GAMSOptions::EgdxCompress::EgdxCompressEnum gdxCompress ()
 Get Compression of generated GDX file. More...
 
void setgdxCompress (const GAMSOptions::EgdxCompress::EgdxCompressEnum value)
 Set Compression of generated GDX file. More...
 
GAMSOptions::EgdxConvert::EgdxConvertEnum gdxConvert ()
 Get Version of GDX files generated (for backward compatibility) More...
 
void setgdxConvert (const GAMSOptions::EgdxConvert::EgdxConvertEnum value)
 Set Version of GDX files generated (for backward compatibility) More...
 
GAMSOptions::EAppendExpand::EAppendExpandEnum appendExpand ()
 Get Expand file append option. More...
 
void setAppendExpand (const GAMSOptions::EAppendExpand::EAppendExpandEnum value)
 Set Expand file append option. More...
 
double eTLim ()
 Get Elapsed time limit in seconds. More...
 
void setETLim (const double value)
 Set Elapsed time limit in seconds. More...
 
double profileTol ()
 Get Minimum time a statement must use to appear in profile generated output. More...
 
void setProfileTol (const double value)
 Set Minimum time a statement must use to appear in profile generated output. More...
 
std::string profileFile ()
 Get Write profile information to this file. More...
 
void setProfileFile (const std::string &value)
 Set Write profile information to this file. More...
 
int maxProcDir ()
 Get Maximum number of 225* process directories. More...
 
void setMaxProcDir (const int value)
 Set Maximum number of 225* process directories. More...
 
int integer1 ()
 Get Integer communication cell N. More...
 
void setInteger1 (const int value)
 Set Integer communication cell N. More...
 
int integer2 ()
 Get Integer communication cell N. More...
 
void setInteger2 (const int value)
 Set Integer communication cell N. More...
 
int integer3 ()
 Get Integer communication cell N. More...
 
void setInteger3 (const int value)
 Set Integer communication cell N. More...
 
int integer4 ()
 Get Integer communication cell N. More...
 
void setInteger4 (const int value)
 Set Integer communication cell N. More...
 
int integer5 ()
 Get Integer communication cell N. More...
 
void setInteger5 (const int value)
 Set Integer communication cell N. More...
 
std::string gridScript ()
 Get Grid submission script. More...
 
void setGridScript (const std::string &value)
 Set Grid submission script. More...
 
int threads ()
 Get Number of threads to be used by a solver. More...
 
void setThreads (const int value)
 Set Number of threads to be used by a solver. More...
 
GAMSOptions::ENoNewVarEqu::ENoNewVarEquEnum noNewVarEqu ()
 Get Triggers a compilation error when new equations or variable symbols are introduced. More...
 
void setNoNewVarEqu (const GAMSOptions::ENoNewVarEqu::ENoNewVarEquEnum value)
 Set Triggers a compilation error when new equations or variable symbols are introduced. More...
 
int forceOptFile ()
 Get Overwrites other option file section mechanism. More...
 
void setForceOptFile (const int value)
 Set Overwrites other option file section mechanism. More...
 
std::string symPrefix ()
 Get Prefix all symbols encountered during compilation by the specified string in work file. More...
 
void setSymPrefix (const std::string &value)
 Set Prefix all symbols encountered during compilation by the specified string in work file. More...
 
GAMSOptions::EgdxUels::EgdxUelsEnum gdxUels ()
 Get Unload labels or UELs to GDX either squeezed or full. More...
 
void setgdxUels (const GAMSOptions::EgdxUels::EgdxUelsEnum value)
 Set Unload labels or UELs to GDX either squeezed or full. More...
 
std::string dumpParmsLogPrefix ()
 Get Prefix of lines triggered by DumpParms>1. More...
 
void setDumpParmsLogPrefix (const std::string &value)
 Set Prefix of lines triggered by DumpParms>1. More...
 
GAMSOptions::EstrictSingleton::EstrictSingletonEnum strictSingleton ()
 Get Error if assignment to singleton set has multiple elements. More...
 
void setstrictSingleton (const GAMSOptions::EstrictSingleton::EstrictSingletonEnum value)
 Set Error if assignment to singleton set has multiple elements. More...
 
double fDDelta ()
 Get Step size for finite differences. More...
 
void setFDDelta (const double value)
 Set Step size for finite differences. More...
 
GAMSOptions::EFDOpt::EFDOptEnum fDOpt ()
 Get Options for finite differences. More...
 
void setFDOpt (const GAMSOptions::EFDOpt::EFDOptEnum value)
 Set Options for finite differences. More...
 
GAMSOptions::EPrefixLoadPath::EPrefixLoadPathEnum prefixLoadPath ()
 Get Prepend GAMS system directory to library load path. More...
 
void setPrefixLoadPath (const GAMSOptions::EPrefixLoadPath::EPrefixLoadPathEnum value)
 Set Prepend GAMS system directory to library load path. More...
 
int threadsAsync ()
 Get Number of threads to be used for asynchronous solve (solveLink=6) More...
 
void setThreadsAsync (const int value)
 Set Number of threads to be used for asynchronous solve (solveLink=6) More...
 
GAMSOptions::EAsyncSolLst::EAsyncSolLstEnum asyncSolLst ()
 Get Print solution listing when asynchronous solve (Grid or Threads) is used. More...
 
void setAsyncSolLst (const GAMSOptions::EAsyncSolLst::EAsyncSolLstEnum value)
 Set Print solution listing when asynchronous solve (Grid or Threads) is used. More...
 
std::string fileStem ()
 Get Sets the file stem for output files which use the input file name as stem by default. More...
 
void setFileStem (const std::string &value)
 Set Sets the file stem for output files which use the input file name as stem by default. More...
 
GAMSOptions::EPySetup::EPySetupEnum pySetup ()
 Get GAMS/Python Setup. More...
 
void setPySetup (const GAMSOptions::EPySetup::EPySetupEnum value)
 Set GAMS/Python Setup. More...
 
GAMSOptions::EPyMultInst::EPyMultInstEnum pyMultInst ()
 Get GAMS/Python Multiple Instance Interpreter. More...
 
void setPyMultInst (const GAMSOptions::EPyMultInst::EPyMultInstEnum value)
 Set GAMS/Python Multiple Instance Interpreter. More...
 
std::string LP ()
 Get default LP solver. More...
 
void setLP (const std::string &value)
 Set default LP solver. More...
 
std::string MIP ()
 Get default MIP solver. More...
 
void setMIP (const std::string &value)
 Set default MIP solver. More...
 
std::string RMIP ()
 Get default RMIP solver. More...
 
void setRMIP (const std::string &value)
 Set default RMIP solver. More...
 
std::string NLP ()
 Get default NLP solver. More...
 
void setNLP (const std::string &value)
 Set default NLP solver. More...
 
std::string MCP ()
 Get default MCP solver. More...
 
void setMCP (const std::string &value)
 Set default MCP solver. More...
 
std::string MPEC ()
 Get default MPEC solver. More...
 
void setMPEC (const std::string &value)
 Set default MPEC solver. More...
 
std::string RMPEC ()
 Get default RMPEC solver. More...
 
void setRMPEC (const std::string &value)
 Set default RMPEC solver. More...
 
std::string CNS ()
 Get default CNS solver. More...
 
void setCNS (const std::string &value)
 Set default CNS solver. More...
 
std::string DNLP ()
 Get default DNLP solver. More...
 
void setDNLP (const std::string &value)
 Set default DNLP solver. More...
 
std::string RMINLP ()
 Get default RMINLP solver. More...
 
void setRMINLP (const std::string &value)
 Set default RMINLP solver. More...
 
std::string MINLP ()
 Get default MINLP solver. More...
 
void setMINLP (const std::string &value)
 Set default MINLP solver. More...
 
std::string QCP ()
 Get default QCP solver. More...
 
void setQCP (const std::string &value)
 Set default QCP solver. More...
 
std::string MIQCP ()
 Get default MIQCP solver. More...
 
void setMIQCP (const std::string &value)
 Set default MIQCP solver. More...
 
std::string RMIQCP ()
 Get default RMIQCP solver. More...
 
void setRMIQCP (const std::string &value)
 Set default RMIQCP solver. More...
 
std::string EMP ()
 Get default EMP solver. More...
 
void setEMP (const std::string &value)
 Set default EMP solver. More...
 
std::string getSolver (const std::string &modelType)
 Get solver by model type. More...
 
void setSolver (const std::string &modelType, const std::string &solver)
 Get solver by model type. More...
 

Static Public Member Functions

static const char * gamsBuild ()
 Get GAMS build information. More...
 
static const char * gamsVersion ()
 Get GAMS version information. More...
 
static std::string eActionText (GAMSOptions::EAction::EActionEnum type)
 Get GAMS processing request as text. More...
 
static std::string eActionCode (GAMSOptions::EAction::EActionEnum type)
 Get GAMS processing request as code. More...
 
static EAction::EActionEnum eActionFromCode (const std::string &str)
 Get GAMS processing request from std::string More...
 
static std::string egdxConvertText (GAMSOptions::EgdxConvert::EgdxConvertEnum type)
 Get Version of GDX files generated (for backward compatibility) as text. More...
 
static std::string egdxConvertCode (GAMSOptions::EgdxConvert::EgdxConvertEnum type)
 Get Version of GDX files generated (for backward compatibility) as code. More...
 
static EgdxConvert::EgdxConvertEnum egdxConvertFromCode (const std::string &str)
 Get Version of GDX files generated (for backward compatibility) from std::string More...
 
static std::string egdxUelsText (GAMSOptions::EgdxUels::EgdxUelsEnum type)
 Get Unload labels or UELs to GDX either squeezed or full as text. More...
 
static std::string egdxUelsCode (GAMSOptions::EgdxUels::EgdxUelsEnum type)
 Get Unload labels or UELs to GDX either squeezed or full as code. More...
 
static EgdxUels::EgdxUelsEnum egdxUelsFromCode (const std::string &str)
 Get Unload labels or UELs to GDX either squeezed or full from std::string More...
 

Detailed Description

The GAMSOptions class manages GAMS options (sometimes also called GAMS parameters since they correspond to the command line parameters of the GAMS executable) for a GAMSJob and GAMSModelInstance. There are integer (e.g. NodLim), double (e.g. ResLim), and string (e.g. PutDir) valued options. There are also a few list options (setDefine() to set string macros inside GAMS and addInputDir() provide multiple search paths for include files) and a power option to set a solver for all suitable model types (setAllModelTypes()).

Some options known from other interfaces to GAMS that are of limited use or could even create problematic situations in the C++ environment are not settable through the GAMSOptions class.

For some options (e.g. Case) other GAMS interfaces use numeric values (e.g. 0,1) while the GAMSOptions class has enumerated types with proper names (e.g. MixedCase, UpperCase).

Definition at line 55 of file gamsoptions.h.

Constructor & Destructor Documentation

◆ ~GAMSOptions()

gams::GAMSOptions::~GAMSOptions ( )

Destructor.

Member Function Documentation

◆ action()

GAMSOptions::EAction::EActionEnum gams::GAMSOptions::action ( )

Get GAMS processing request.

◆ addInputDir()

void gams::GAMSOptions::addInputDir ( const std::string  value)

Add new inputdir at the end of the inputdir list.

◆ appendExpand()

GAMSOptions::EAppendExpand::EAppendExpandEnum gams::GAMSOptions::appendExpand ( )

Get Expand file append option.

◆ appendOut()

GAMSOptions::EAppendOut::EAppendOutEnum gams::GAMSOptions::appendOut ( )

Get Output file append option.

◆ asyncSolLst()

GAMSOptions::EAsyncSolLst::EAsyncSolLstEnum gams::GAMSOptions::asyncSolLst ( )

Get Print solution listing when asynchronous solve (Grid or Threads) is used.

◆ bratio()

double gams::GAMSOptions::bratio ( )

Get Basis acceptance threshold.

◆ cErr()

int gams::GAMSOptions::cErr ( )

Get Compile time error limit.

◆ charSet()

GAMSOptions::ECharSet::ECharSetEnum gams::GAMSOptions::charSet ( )

Get Character set flag.

◆ CNS()

std::string gams::GAMSOptions::CNS ( )

Get default CNS solver.

◆ dFormat()

GAMSOptions::EDFormat::EDFormatEnum gams::GAMSOptions::dFormat ( )

Get Date format.

◆ DNLP()

std::string gams::GAMSOptions::DNLP ( )

Get default DNLP solver.

◆ domLim()

int gams::GAMSOptions::domLim ( )

Get Domain violation limit solver default.

◆ dumpOpt()

GAMSOptions::EDumpOpt::EDumpOptEnum gams::GAMSOptions::dumpOpt ( )

Get Writes preprocessed input to the file input.dmp.

◆ dumpParms()

GAMSOptions::EDumpParms::EDumpParmsEnum gams::GAMSOptions::dumpParms ( )

Get GAMS parameter logging.

◆ dumpParmsLogPrefix()

std::string gams::GAMSOptions::dumpParmsLogPrefix ( )

Get Prefix of lines triggered by DumpParms>1.

◆ eActionCode()

static std::string gams::GAMSOptions::eActionCode ( GAMSOptions::EAction::EActionEnum  type)
static

Get GAMS processing request as code.

◆ eActionFromCode()

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

Get GAMS processing request from std::string

◆ eActionText()

static std::string gams::GAMSOptions::eActionText ( GAMSOptions::EAction::EActionEnum  type)
static

Get GAMS processing request as text.

◆ egdxConvertCode()

static std::string gams::GAMSOptions::egdxConvertCode ( GAMSOptions::EgdxConvert::EgdxConvertEnum  type)
static

Get Version of GDX files generated (for backward compatibility) as code.

◆ egdxConvertFromCode()

static EgdxConvert::EgdxConvertEnum gams::GAMSOptions::egdxConvertFromCode ( const std::string &  str)
static

Get Version of GDX files generated (for backward compatibility) from std::string

◆ egdxConvertText()

static std::string gams::GAMSOptions::egdxConvertText ( GAMSOptions::EgdxConvert::EgdxConvertEnum  type)
static

Get Version of GDX files generated (for backward compatibility) as text.

◆ egdxUelsCode()

static std::string gams::GAMSOptions::egdxUelsCode ( GAMSOptions::EgdxUels::EgdxUelsEnum  type)
static

Get Unload labels or UELs to GDX either squeezed or full as code.

◆ egdxUelsFromCode()

static EgdxUels::EgdxUelsEnum gams::GAMSOptions::egdxUelsFromCode ( const std::string &  str)
static

Get Unload labels or UELs to GDX either squeezed or full from std::string

◆ egdxUelsText()

static std::string gams::GAMSOptions::egdxUelsText ( GAMSOptions::EgdxUels::EgdxUelsEnum  type)
static

Get Unload labels or UELs to GDX either squeezed or full as text.

◆ EMP()

std::string gams::GAMSOptions::EMP ( )

Get default EMP solver.

◆ errMsg()

GAMSOptions::EErrMsg::EErrMsgEnum gams::GAMSOptions::errMsg ( )

Get Placing of compilation error messages.

◆ errorLog()

int gams::GAMSOptions::errorLog ( )

Get Max error message lines written to the log for each error.

◆ eTLim()

double gams::GAMSOptions::eTLim ( )

Get Elapsed time limit in seconds.

◆ execErr()

int gams::GAMSOptions::execErr ( )

Get Execution time error limit.

◆ execMode()

GAMSOptions::EExecMode::EExecModeEnum gams::GAMSOptions::execMode ( )

Get Limits on external programs that are allowed to be executed.

◆ expand()

std::string gams::GAMSOptions::expand ( )

Get Expanded (include) input file name.

◆ fDDelta()

double gams::GAMSOptions::fDDelta ( )

Get Step size for finite differences.

◆ fDOpt()

GAMSOptions::EFDOpt::EFDOptEnum gams::GAMSOptions::fDOpt ( )

Get Options for finite differences.

◆ fErr()

std::string gams::GAMSOptions::fErr ( )

Get Alternative error message file.

◆ fileCase()

GAMSOptions::EFileCase::EFileCaseEnum gams::GAMSOptions::fileCase ( )

Get Casing of new file names (put, gdx, ref etc.)

◆ fileStem()

std::string gams::GAMSOptions::fileStem ( )

Get Sets the file stem for output files which use the input file name as stem by default.

◆ forceOptFile()

int gams::GAMSOptions::forceOptFile ( )

Get Overwrites other option file section mechanism.

◆ forceWork()

GAMSOptions::EForceWork::EForceWorkEnum gams::GAMSOptions::forceWork ( )

Get Force GAMS systems to process save files for example with an execution error.

◆ forLim()

int gams::GAMSOptions::forLim ( )

Get GAMS looping limit.

◆ gamsBuild()

static const char* gams::GAMSOptions::gamsBuild ( )
static

Get GAMS build information.

◆ gamsVersion()

static const char* gams::GAMSOptions::gamsVersion ( )
static

Get GAMS version information.

◆ gdx()

std::string gams::GAMSOptions::gdx ( )

Get GDX file name.

◆ gdxCompress()

GAMSOptions::EgdxCompress::EgdxCompressEnum gams::GAMSOptions::gdxCompress ( )

Get Compression of generated GDX file.

◆ gdxConvert()

GAMSOptions::EgdxConvert::EgdxConvertEnum gams::GAMSOptions::gdxConvert ( )

Get Version of GDX files generated (for backward compatibility)

◆ gdxUels()

GAMSOptions::EgdxUels::EgdxUelsEnum gams::GAMSOptions::gdxUels ( )

Get Unload labels or UELs to GDX either squeezed or full.

◆ getDefine()

std::string gams::GAMSOptions::getDefine ( const std::string &  key)

Get value of previously set double-dash –key-value option pair.

◆ getInputDir()

std::string gams::GAMSOptions::getInputDir ( const int  index)

Get an inputdir at position index of the inputdir list.

◆ getSolver()

std::string gams::GAMSOptions::getSolver ( const std::string &  modelType)

Get solver by model type.

◆ gridDir()

std::string gams::GAMSOptions::gridDir ( )

Get Grid file directory.

◆ gridScript()

std::string gams::GAMSOptions::gridScript ( )

Get Grid submission script.

◆ heapLimit()

double gams::GAMSOptions::heapLimit ( )

Get Maximum Heap size allowed in MB.

◆ holdFixed()

GAMSOptions::EHoldFixed::EHoldFixedEnum gams::GAMSOptions::holdFixed ( )

Get Treat fixed variables as constants.

◆ inputDirSize()

int gams::GAMSOptions::inputDirSize ( )

Get the size of the inputdir list.

◆ integer1()

int gams::GAMSOptions::integer1 ( )

Get Integer communication cell N.

◆ integer2()

int gams::GAMSOptions::integer2 ( )

Get Integer communication cell N.

◆ integer3()

int gams::GAMSOptions::integer3 ( )

Get Integer communication cell N.

◆ integer4()

int gams::GAMSOptions::integer4 ( )

Get Integer communication cell N.

◆ integer5()

int gams::GAMSOptions::integer5 ( )

Get Integer communication cell N.

◆ interactiveSolver()

GAMSOptions::EInteractiveSolver::EInteractiveSolverEnum gams::GAMSOptions::interactiveSolver ( )

Get Allow solver to interact via command line input.

◆ intVarUp()

GAMSOptions::EIntVarUp::EIntVarUpEnum gams::GAMSOptions::intVarUp ( )

Get Set default upper bound on integer variables.

◆ iterLim()

int gams::GAMSOptions::iterLim ( )

Get Iteration limit of solver.

◆ jobTrace()

std::string gams::GAMSOptions::jobTrace ( )

Get Job trace string to be written to the trace file at the end of a GAMS job.

◆ keep()

GAMSOptions::EKeep::EKeepEnum gams::GAMSOptions::keep ( )

Get Controls keeping or deletion of process directory and scratch files.

◆ libIncDir()

std::string gams::GAMSOptions::libIncDir ( )

Get LibInclude directory.

◆ license()

std::string gams::GAMSOptions::license ( )

Get Use alternative license file.

◆ limCol()

int gams::GAMSOptions::limCol ( )

Get Maximum number of columns listed in one variable block.

◆ limRow()

int gams::GAMSOptions::limRow ( )

Get Maximum number of rows listed in one equation block.

◆ logID()

LogId gams::GAMSOptions::logID ( )

Get the GAMS log ID.

Returns
Returns the GAMS log ID.

◆ logLine()

GAMSOptions::ELogLine::ELogLineEnum gams::GAMSOptions::logLine ( )

Get Amount of line tracing to the log file.

◆ LP()

std::string gams::GAMSOptions::LP ( )

Get default LP solver.

◆ lstCase()

int gams::GAMSOptions::lstCase ( )

Get Output case option for LST file.

◆ maxProcDir()

int gams::GAMSOptions::maxProcDir ( )

Get Maximum number of 225* process directories.

◆ MCP()

std::string gams::GAMSOptions::MCP ( )

Get default MCP solver.

◆ MINLP()

std::string gams::GAMSOptions::MINLP ( )

Get default MINLP solver.

◆ MIP()

std::string gams::GAMSOptions::MIP ( )

Get default MIP solver.

◆ MIQCP()

std::string gams::GAMSOptions::MIQCP ( )

Get default MIQCP solver.

◆ MPEC()

std::string gams::GAMSOptions::MPEC ( )

Get default MPEC solver.

◆ NLP()

std::string gams::GAMSOptions::NLP ( )

Get default NLP solver.

◆ nodLim()

int gams::GAMSOptions::nodLim ( )

Get Node limit in branch and bound tree.

◆ noNewVarEqu()

GAMSOptions::ENoNewVarEqu::ENoNewVarEquEnum gams::GAMSOptions::noNewVarEqu ( )

Get Triggers a compilation error when new equations or variable symbols are introduced.

◆ on115()

GAMSOptions::EOn115::EOn115Enum gams::GAMSOptions::on115 ( )

Get Generate errors for unknown unique element in an equation.

◆ optCA()

double gams::GAMSOptions::optCA ( )

Get Absolute Optimality criterion solver default.

◆ optCR()

double gams::GAMSOptions::optCR ( )

Get Relative Optimality criterion solver default.

◆ optDir()

std::string gams::GAMSOptions::optDir ( )

Get Option file directory.

◆ optFile()

int gams::GAMSOptions::optFile ( )

Get Default option file.

◆ output()

std::string gams::GAMSOptions::output ( )

Get Listing file name.

◆ pageContr()

GAMSOptions::EPageContr::EPageContrEnum gams::GAMSOptions::pageContr ( )

Get Output file page control option.

◆ pageSize()

int gams::GAMSOptions::pageSize ( )

Get Output file page size (=0 no paging)

◆ pageWidth()

int gams::GAMSOptions::pageWidth ( )

Get Output file page width.

◆ pLicense()

std::string gams::GAMSOptions::pLicense ( )

Get Privacy license file name.

◆ prefixLoadPath()

GAMSOptions::EPrefixLoadPath::EPrefixLoadPathEnum gams::GAMSOptions::prefixLoadPath ( )

Get Prepend GAMS system directory to library load path.

◆ profile()

int gams::GAMSOptions::profile ( )

Get Execution profiling.

◆ profileFile()

std::string gams::GAMSOptions::profileFile ( )

Get Write profile information to this file.

◆ profileTol()

double gams::GAMSOptions::profileTol ( )

Get Minimum time a statement must use to appear in profile generated output.

◆ putDir()

std::string gams::GAMSOptions::putDir ( )

Get Put file directory.

◆ pyMultInst()

GAMSOptions::EPyMultInst::EPyMultInstEnum gams::GAMSOptions::pyMultInst ( )

Get GAMS/Python Multiple Instance Interpreter.

◆ pySetup()

GAMSOptions::EPySetup::EPySetupEnum gams::GAMSOptions::pySetup ( )

Get GAMS/Python Setup.

◆ QCP()

std::string gams::GAMSOptions::QCP ( )

Get default QCP solver.

◆ reference()

std::string gams::GAMSOptions::reference ( )

Get Symbol reference file.

◆ removeDefine()

bool gams::GAMSOptions::removeDefine ( const std::string &  key)

Remove a double-dash option.

◆ removeInputDir()

void gams::GAMSOptions::removeInputDir ( const int  index)

Remove an inputdir at position index of the inputdir list.

◆ resLim()

double gams::GAMSOptions::resLim ( )

Get Wall-clock time limit for solver.

◆ RMINLP()

std::string gams::GAMSOptions::RMINLP ( )

Get default RMINLP solver.

◆ RMIP()

std::string gams::GAMSOptions::RMIP ( )

Get default RMIP solver.

◆ RMIQCP()

std::string gams::GAMSOptions::RMIQCP ( )

Get default RMIQCP solver.

◆ RMPEC()

std::string gams::GAMSOptions::RMPEC ( )

Get default RMPEC solver.

◆ savePoint()

GAMSOptions::ESavePoint::ESavePointEnum gams::GAMSOptions::savePoint ( )

Get Save solver point in GDX file.

◆ scriptExit()

std::string gams::GAMSOptions::scriptExit ( )

Get Program or script to be executed at the end of a GAMS run.

◆ seed()

int gams::GAMSOptions::seed ( )

Get Random number seed.

◆ setAction()

void gams::GAMSOptions::setAction ( const GAMSOptions::EAction::EActionEnum  value)

Set GAMS processing request.

◆ setAllModelTypes()

void gams::GAMSOptions::setAllModelTypes ( const std::string &  solver)

Set the solver for all model types the solver can handle.

◆ setAppendExpand()

void gams::GAMSOptions::setAppendExpand ( const GAMSOptions::EAppendExpand::EAppendExpandEnum  value)

Set Expand file append option.

◆ setAppendOut()

void gams::GAMSOptions::setAppendOut ( const GAMSOptions::EAppendOut::EAppendOutEnum  value)

Set Output file append option.

◆ setAsyncSolLst()

void gams::GAMSOptions::setAsyncSolLst ( const GAMSOptions::EAsyncSolLst::EAsyncSolLstEnum  value)

Set Print solution listing when asynchronous solve (Grid or Threads) is used.

◆ setBratio()

void gams::GAMSOptions::setBratio ( const double  value)

Set Basis acceptance threshold.

◆ setCErr()

void gams::GAMSOptions::setCErr ( const int  value)

Set Compile time error limit.

◆ setCharSet()

void gams::GAMSOptions::setCharSet ( const GAMSOptions::ECharSet::ECharSetEnum  value)

Set Character set flag.

◆ setCNS()

void gams::GAMSOptions::setCNS ( const std::string &  value)

Set default CNS solver.

◆ setDefine()

void gams::GAMSOptions::setDefine ( const std::string &  key,
const std::string &  value 
)

Set double-dash –key=value option pair.

◆ setDFormat()

void gams::GAMSOptions::setDFormat ( const GAMSOptions::EDFormat::EDFormatEnum  value)

Set Date format.

◆ setDNLP()

void gams::GAMSOptions::setDNLP ( const std::string &  value)

Set default DNLP solver.

◆ setDomLim()

void gams::GAMSOptions::setDomLim ( const int  value)

Set Domain violation limit solver default.

◆ setDumpOpt()

void gams::GAMSOptions::setDumpOpt ( const GAMSOptions::EDumpOpt::EDumpOptEnum  value)

Set Writes preprocessed input to the file input.dmp.

◆ setDumpParms()

void gams::GAMSOptions::setDumpParms ( const GAMSOptions::EDumpParms::EDumpParmsEnum  value)

Set GAMS parameter logging.

◆ setDumpParmsLogPrefix()

void gams::GAMSOptions::setDumpParmsLogPrefix ( const std::string &  value)

Set Prefix of lines triggered by DumpParms>1.

◆ setEMP()

void gams::GAMSOptions::setEMP ( const std::string &  value)

Set default EMP solver.

◆ setErrMsg()

void gams::GAMSOptions::setErrMsg ( const GAMSOptions::EErrMsg::EErrMsgEnum  value)

Set Placing of compilation error messages.

◆ setErrorLog()

void gams::GAMSOptions::setErrorLog ( const int  value)

Set Max error message lines written to the log for each error.

◆ setETLim()

void gams::GAMSOptions::setETLim ( const double  value)

Set Elapsed time limit in seconds.

◆ setExecErr()

void gams::GAMSOptions::setExecErr ( const int  value)

Set Execution time error limit.

◆ setExecMode()

void gams::GAMSOptions::setExecMode ( const GAMSOptions::EExecMode::EExecModeEnum  value)

Set Limits on external programs that are allowed to be executed.

◆ setExpand()

void gams::GAMSOptions::setExpand ( const std::string &  value)

Set Expanded (include) input file name.

◆ setFDDelta()

void gams::GAMSOptions::setFDDelta ( const double  value)

Set Step size for finite differences.

◆ setFDOpt()

void gams::GAMSOptions::setFDOpt ( const GAMSOptions::EFDOpt::EFDOptEnum  value)

Set Options for finite differences.

◆ setFErr()

void gams::GAMSOptions::setFErr ( const std::string &  value)

Set Alternative error message file.

◆ setFileCase()

void gams::GAMSOptions::setFileCase ( const GAMSOptions::EFileCase::EFileCaseEnum  value)

Set Casing of new file names (put, gdx, ref etc.)

◆ setFileStem()

void gams::GAMSOptions::setFileStem ( const std::string &  value)

Set Sets the file stem for output files which use the input file name as stem by default.

◆ setForceOptFile()

void gams::GAMSOptions::setForceOptFile ( const int  value)

Set Overwrites other option file section mechanism.

◆ setForceWork()

void gams::GAMSOptions::setForceWork ( const GAMSOptions::EForceWork::EForceWorkEnum  value)

Set Force GAMS systems to process save files for example with an execution error.

◆ setForLim()

void gams::GAMSOptions::setForLim ( const int  value)

Set GAMS looping limit.

◆ setGdx()

void gams::GAMSOptions::setGdx ( const std::string &  value)

Set GDX file name.

◆ setgdxCompress()

void gams::GAMSOptions::setgdxCompress ( const GAMSOptions::EgdxCompress::EgdxCompressEnum  value)

Set Compression of generated GDX file.

◆ setgdxConvert()

void gams::GAMSOptions::setgdxConvert ( const GAMSOptions::EgdxConvert::EgdxConvertEnum  value)

Set Version of GDX files generated (for backward compatibility)

◆ setgdxUels()

void gams::GAMSOptions::setgdxUels ( const GAMSOptions::EgdxUels::EgdxUelsEnum  value)

Set Unload labels or UELs to GDX either squeezed or full.

◆ setGridDir()

void gams::GAMSOptions::setGridDir ( const std::string &  value)

Set Grid file directory.

◆ setGridScript()

void gams::GAMSOptions::setGridScript ( const std::string &  value)

Set Grid submission script.

◆ setHeapLimit()

void gams::GAMSOptions::setHeapLimit ( const double  value)

Set Maximum Heap size allowed in MB.

◆ setHoldFixed()

void gams::GAMSOptions::setHoldFixed ( const GAMSOptions::EHoldFixed::EHoldFixedEnum  value)

Set Treat fixed variables as constants.

◆ setInputDir()

void gams::GAMSOptions::setInputDir ( const std::string  value,
const int  index 
)

Replace inputdir at the specified index of the inputdir list.

◆ setInteger1()

void gams::GAMSOptions::setInteger1 ( const int  value)

Set Integer communication cell N.

◆ setInteger2()

void gams::GAMSOptions::setInteger2 ( const int  value)

Set Integer communication cell N.

◆ setInteger3()

void gams::GAMSOptions::setInteger3 ( const int  value)

Set Integer communication cell N.

◆ setInteger4()

void gams::GAMSOptions::setInteger4 ( const int  value)

Set Integer communication cell N.

◆ setInteger5()

void gams::GAMSOptions::setInteger5 ( const int  value)

Set Integer communication cell N.

◆ setInteractiveSolver()

void gams::GAMSOptions::setInteractiveSolver ( const GAMSOptions::EInteractiveSolver::EInteractiveSolverEnum  value)

Set Allow solver to interact via command line input.

◆ setIntVarUp()

void gams::GAMSOptions::setIntVarUp ( const GAMSOptions::EIntVarUp::EIntVarUpEnum  value)

Set Set default upper bound on integer variables.

◆ setIterLim()

void gams::GAMSOptions::setIterLim ( const int  value)

Set Iteration limit of solver.

◆ setJobTrace()

void gams::GAMSOptions::setJobTrace ( const std::string &  value)

Set Job trace string to be written to the trace file at the end of a GAMS job.

◆ setKeep()

void gams::GAMSOptions::setKeep ( const GAMSOptions::EKeep::EKeepEnum  value)

Set Controls keeping or deletion of process directory and scratch files.

◆ setLibIncDir()

void gams::GAMSOptions::setLibIncDir ( const std::string &  value)

Set LibInclude directory.

◆ setLicense()

void gams::GAMSOptions::setLicense ( const std::string &  value)

Set Use alternative license file.

◆ setLimCol()

void gams::GAMSOptions::setLimCol ( const int  value)

Set Maximum number of columns listed in one variable block.

◆ setLimRow()

void gams::GAMSOptions::setLimRow ( const int  value)

Set Maximum number of rows listed in one equation block.

◆ setLogLine()

void gams::GAMSOptions::setLogLine ( const GAMSOptions::ELogLine::ELogLineEnum  value)

Set Amount of line tracing to the log file.

◆ setLP()

void gams::GAMSOptions::setLP ( const std::string &  value)

Set default LP solver.

◆ setLstCase()

void gams::GAMSOptions::setLstCase ( const int  value)

Set Output case option for LST file.

◆ setMaxProcDir()

void gams::GAMSOptions::setMaxProcDir ( const int  value)

Set Maximum number of 225* process directories.

◆ setMCP()

void gams::GAMSOptions::setMCP ( const std::string &  value)

Set default MCP solver.

◆ setMINLP()

void gams::GAMSOptions::setMINLP ( const std::string &  value)

Set default MINLP solver.

◆ setMIP()

void gams::GAMSOptions::setMIP ( const std::string &  value)

Set default MIP solver.

◆ setMIQCP()

void gams::GAMSOptions::setMIQCP ( const std::string &  value)

Set default MIQCP solver.

◆ setMPEC()

void gams::GAMSOptions::setMPEC ( const std::string &  value)

Set default MPEC solver.

◆ setNLP()

void gams::GAMSOptions::setNLP ( const std::string &  value)

Set default NLP solver.

◆ setNodLim()

void gams::GAMSOptions::setNodLim ( const int  value)

Set Node limit in branch and bound tree.

◆ setNoNewVarEqu()

void gams::GAMSOptions::setNoNewVarEqu ( const GAMSOptions::ENoNewVarEqu::ENoNewVarEquEnum  value)

Set Triggers a compilation error when new equations or variable symbols are introduced.

◆ setOn115()

void gams::GAMSOptions::setOn115 ( const GAMSOptions::EOn115::EOn115Enum  value)

Set Generate errors for unknown unique element in an equation.

◆ setOptCA()

void gams::GAMSOptions::setOptCA ( const double  value)

Set Absolute Optimality criterion solver default.

◆ setOptCR()

void gams::GAMSOptions::setOptCR ( const double  value)

Set Relative Optimality criterion solver default.

◆ setOptDir()

void gams::GAMSOptions::setOptDir ( const std::string &  value)

Set Option file directory.

◆ setOptFile()

void gams::GAMSOptions::setOptFile ( const int  value)

Set Default option file.

◆ setOutput()

void gams::GAMSOptions::setOutput ( const std::string &  value)

Set Listing file name.

◆ setPageContr()

void gams::GAMSOptions::setPageContr ( const GAMSOptions::EPageContr::EPageContrEnum  value)

Set Output file page control option.

◆ setPageSize()

void gams::GAMSOptions::setPageSize ( const int  value)

Set Output file page size (=0 no paging)

◆ setPageWidth()

void gams::GAMSOptions::setPageWidth ( const int  value)

Set Output file page width.

◆ setPLicense()

void gams::GAMSOptions::setPLicense ( const std::string &  value)

Set Privacy license file name.

◆ setPrefixLoadPath()

void gams::GAMSOptions::setPrefixLoadPath ( const GAMSOptions::EPrefixLoadPath::EPrefixLoadPathEnum  value)

Set Prepend GAMS system directory to library load path.

◆ setProfile()

void gams::GAMSOptions::setProfile ( const int  value)

Set Execution profiling.

◆ setProfileFile()

void gams::GAMSOptions::setProfileFile ( const std::string &  value)

Set Write profile information to this file.

◆ setProfileTol()

void gams::GAMSOptions::setProfileTol ( const double  value)

Set Minimum time a statement must use to appear in profile generated output.

◆ setPutDir()

void gams::GAMSOptions::setPutDir ( const std::string &  value)

Set Put file directory.

◆ setPyMultInst()

void gams::GAMSOptions::setPyMultInst ( const GAMSOptions::EPyMultInst::EPyMultInstEnum  value)

Set GAMS/Python Multiple Instance Interpreter.

◆ setPySetup()

void gams::GAMSOptions::setPySetup ( const GAMSOptions::EPySetup::EPySetupEnum  value)

Set GAMS/Python Setup.

◆ setQCP()

void gams::GAMSOptions::setQCP ( const std::string &  value)

Set default QCP solver.

◆ setReference()

void gams::GAMSOptions::setReference ( const std::string &  value)

Set Symbol reference file.

◆ setResLim()

void gams::GAMSOptions::setResLim ( const double  value)

Set Wall-clock time limit for solver.

◆ setRMINLP()

void gams::GAMSOptions::setRMINLP ( const std::string &  value)

Set default RMINLP solver.

◆ setRMIP()

void gams::GAMSOptions::setRMIP ( const std::string &  value)

Set default RMIP solver.

◆ setRMIQCP()

void gams::GAMSOptions::setRMIQCP ( const std::string &  value)

Set default RMIQCP solver.

◆ setRMPEC()

void gams::GAMSOptions::setRMPEC ( const std::string &  value)

Set default RMPEC solver.

◆ setSavePoint()

void gams::GAMSOptions::setSavePoint ( const GAMSOptions::ESavePoint::ESavePointEnum  value)

Set Save solver point in GDX file.

◆ setScriptExit()

void gams::GAMSOptions::setScriptExit ( const std::string &  value)

Set Program or script to be executed at the end of a GAMS run.

◆ setSeed()

void gams::GAMSOptions::setSeed ( const int  value)

Set Random number seed.

◆ setSolPrint()

void gams::GAMSOptions::setSolPrint ( const GAMSOptions::ESolPrint::ESolPrintEnum  value)

Set Solution report print option.

◆ setSolveLink()

void gams::GAMSOptions::setSolveLink ( const GAMSOptions::ESolveLink::ESolveLinkEnum  value)

Set Solver link option.

◆ setSolver()

void gams::GAMSOptions::setSolver ( const std::string &  modelType,
const std::string &  solver 
)

Get solver by model type.

◆ setStepSum()

void gams::GAMSOptions::setStepSum ( const GAMSOptions::EStepSum::EStepSumEnum  value)

Set Summary of computing resources used by job steps.

◆ setstrictSingleton()

void gams::GAMSOptions::setstrictSingleton ( const GAMSOptions::EstrictSingleton::EstrictSingletonEnum  value)

Set Error if assignment to singleton set has multiple elements.

◆ setStringChk()

void gams::GAMSOptions::setStringChk ( const GAMSOptions::EStringChk::EStringChkEnum  value)

Set String substitution options.

◆ setSuppress()

void gams::GAMSOptions::setSuppress ( const GAMSOptions::ESuppress::ESuppressEnum  value)

Set Compiler listing option.

◆ setSymbol()

void gams::GAMSOptions::setSymbol ( const std::string &  value)

Set Symbol table file.

◆ setSymPrefix()

void gams::GAMSOptions::setSymPrefix ( const std::string &  value)

Set Prefix all symbols encountered during compilation by the specified string in work file.

◆ setSys10()

void gams::GAMSOptions::setSys10 ( const GAMSOptions::ESys10::ESys10Enum  value)

Set Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.

◆ setSys11()

void gams::GAMSOptions::setSys11 ( const GAMSOptions::ESys11::ESys11Enum  value)

Set Dynamic resorting if indices in assignment/data statements are not in natural order.

◆ setSys12()

void gams::GAMSOptions::setSys12 ( const int  value)

Set Pass model with generation errors to solver.

◆ setSysIncDir()

void gams::GAMSOptions::setSysIncDir ( const std::string &  value)

Set SysInclude directory.

◆ setSysOut()

void gams::GAMSOptions::setSysOut ( const GAMSOptions::ESysOut::ESysOutEnum  value)

Set Solver Status file reporting option.

◆ setTabIn()

void gams::GAMSOptions::setTabIn ( const int  value)

Set Tab spacing.

◆ setTFormat()

void gams::GAMSOptions::setTFormat ( const GAMSOptions::ETFormat::ETFormatEnum  value)

Set Time format.

◆ setThreads()

void gams::GAMSOptions::setThreads ( const int  value)

Set Number of threads to be used by a solver.

◆ setThreadsAsync()

void gams::GAMSOptions::setThreadsAsync ( const int  value)

Set Number of threads to be used for asynchronous solve (solveLink=6)

◆ setTimer()

void gams::GAMSOptions::setTimer ( const int  value)

Set Instruction timer threshold in milli seconds.

◆ setTrace()

void gams::GAMSOptions::setTrace ( const std::string &  value)

Set Trace file name.

◆ setTraceLevel()

void gams::GAMSOptions::setTraceLevel ( const int  value)

Set Solvestat threshold used in conjunction with action=GT.

◆ setTraceOpt()

void gams::GAMSOptions::setTraceOpt ( const GAMSOptions::ETraceOpt::ETraceOptEnum  value)

Set Trace file format option.

◆ setUser1()

void gams::GAMSOptions::setUser1 ( const std::string &  value)

Set User string N.

◆ setUser2()

void gams::GAMSOptions::setUser2 ( const std::string &  value)

Set User string N.

◆ setUser3()

void gams::GAMSOptions::setUser3 ( const std::string &  value)

Set User string N.

◆ setUser4()

void gams::GAMSOptions::setUser4 ( const std::string &  value)

Set User string N.

◆ setUser5()

void gams::GAMSOptions::setUser5 ( const std::string &  value)

Set User string N.

◆ setWarnings()

void gams::GAMSOptions::setWarnings ( const int  value)

Set Number of warnings permitted before a run terminates.

◆ setWorkFactor()

void gams::GAMSOptions::setWorkFactor ( const double  value)

Set Memory Estimate multiplier for some solvers.

◆ setWorkSpace()

void gams::GAMSOptions::setWorkSpace ( const double  value)

Set Work space for some solvers in MB.

◆ setZeroRes()

void gams::GAMSOptions::setZeroRes ( const double  value)

Set The results of certain operations will be set to zero if abs(result) LE ZeroRes.

◆ setZeroResRep()

void gams::GAMSOptions::setZeroResRep ( const GAMSOptions::EZeroResRep::EZeroResRepEnum  value)

Set Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.

◆ solPrint()

GAMSOptions::ESolPrint::ESolPrintEnum gams::GAMSOptions::solPrint ( )

Get Solution report print option.

◆ solveLink()

GAMSOptions::ESolveLink::ESolveLinkEnum gams::GAMSOptions::solveLink ( )

Get Solver link option.

◆ stepSum()

GAMSOptions::EStepSum::EStepSumEnum gams::GAMSOptions::stepSum ( )

Get Summary of computing resources used by job steps.

◆ strictSingleton()

GAMSOptions::EstrictSingleton::EstrictSingletonEnum gams::GAMSOptions::strictSingleton ( )

Get Error if assignment to singleton set has multiple elements.

◆ stringChk()

GAMSOptions::EStringChk::EStringChkEnum gams::GAMSOptions::stringChk ( )

Get String substitution options.

◆ suppress()

GAMSOptions::ESuppress::ESuppressEnum gams::GAMSOptions::suppress ( )

Get Compiler listing option.

◆ symbol()

std::string gams::GAMSOptions::symbol ( )

Get Symbol table file.

◆ symPrefix()

std::string gams::GAMSOptions::symPrefix ( )

Get Prefix all symbols encountered during compilation by the specified string in work file.

◆ sys10()

GAMSOptions::ESys10::ESys10Enum gams::GAMSOptions::sys10 ( )

Get Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.

◆ sys11()

GAMSOptions::ESys11::ESys11Enum gams::GAMSOptions::sys11 ( )

Get Dynamic resorting if indices in assignment/data statements are not in natural order.

◆ sys12()

int gams::GAMSOptions::sys12 ( )

Get Pass model with generation errors to solver.

◆ sysIncDir()

std::string gams::GAMSOptions::sysIncDir ( )

Get SysInclude directory.

◆ sysOut()

GAMSOptions::ESysOut::ESysOutEnum gams::GAMSOptions::sysOut ( )

Get Solver Status file reporting option.

◆ tabIn()

int gams::GAMSOptions::tabIn ( )

Get Tab spacing.

◆ tFormat()

GAMSOptions::ETFormat::ETFormatEnum gams::GAMSOptions::tFormat ( )

Get Time format.

◆ threads()

int gams::GAMSOptions::threads ( )

Get Number of threads to be used by a solver.

◆ threadsAsync()

int gams::GAMSOptions::threadsAsync ( )

Get Number of threads to be used for asynchronous solve (solveLink=6)

◆ timer()

int gams::GAMSOptions::timer ( )

Get Instruction timer threshold in milli seconds.

◆ trace()

std::string gams::GAMSOptions::trace ( )

Get Trace file name.

◆ traceLevel()

int gams::GAMSOptions::traceLevel ( )

Get Solvestat threshold used in conjunction with action=GT.

◆ traceOpt()

GAMSOptions::ETraceOpt::ETraceOptEnum gams::GAMSOptions::traceOpt ( )

Get Trace file format option.

◆ user1()

std::string gams::GAMSOptions::user1 ( )

Get User string N.

◆ user2()

std::string gams::GAMSOptions::user2 ( )

Get User string N.

◆ user3()

std::string gams::GAMSOptions::user3 ( )

Get User string N.

◆ user4()

std::string gams::GAMSOptions::user4 ( )

Get User string N.

◆ user5()

std::string gams::GAMSOptions::user5 ( )

Get User string N.

◆ warnings()

int gams::GAMSOptions::warnings ( )

Get Number of warnings permitted before a run terminates.

◆ workFactor()

double gams::GAMSOptions::workFactor ( )

Get Memory Estimate multiplier for some solvers.

◆ workSpace()

double gams::GAMSOptions::workSpace ( )

Get Work space for some solvers in MB.

◆ writeOptionFile()

void gams::GAMSOptions::writeOptionFile ( const std::string &  optFileName)

Export options to an option file.

◆ zeroRes()

double gams::GAMSOptions::zeroRes ( )

Get The results of certain operations will be set to zero if abs(result) LE ZeroRes.

◆ zeroResRep()

GAMSOptions::EZeroResRep::EZeroResRepEnum gams::GAMSOptions::zeroResRep ( )

Get Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.