gamsoptions.h
1/*
2  *
3  * GAMS - General Algebraic Modeling System C++ API
4  *
5  * Copyright (c) 2017-2022 GAMS Development Corp. <support@gams.com>
6  * Copyright (c) 2017-2022 GAMS Software GmbH <support@gams.com>
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a copy
9  * of this software and associated documentation files (the "Software"), to deal
10  * in the Software without restriction, including without limitation the rights
11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12  * copies of the Software, and to permit persons to whom the Software is
13  * furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in all
16  * copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24  * SOFTWARE.
25  *
26  * This file was generated.
27  */
28 
29 #ifndef GAMSOPTIONS_H
30 #define GAMSOPTIONS_H
31 #include "gamslib_global.h"
32 #include <vector>
33 #include <map>
34 #include <string>
35 #include "gamsworkspace.h"
36 
37 namespace gams {
38 
39 class GAMSOptionsImpl;
40 
54 class LIBSPEC GAMSOptions
55 {
56  friend class GAMSModelInstanceImpl;
57  friend class GAMSJobImpl;
58  friend class GAMSWorkspaceImpl;
59 
60 public:
62  struct EAction
63  {
66  {
67  RestartAfterSolve = 0,
68  CompileOnly = 1,
69  ExecuteOnly = 2,
70  CompileAndExecute = 3,
71  GlueCodeGeneration = 4,
72  TraceReport = 5
73  };
74  };
77  {
80  {
81  Reset = 0,
82  Append = 1
83  };
84  };
86  struct EAppendOut
87  {
90  {
91  Reset = 0,
92  Append = 1
93  };
94  };
96  struct EAsyncSolLst
97  {
100  {
101  Off = 0,
102  On = 1
103  };
104  };
107  {
110  {
111  Off = 0,
112  On = 1
113  };
114  };
116  struct ECase
117  {
120  {
121  MixedCase = 0,
122  UpperCase = 1
123  };
124  };
126  struct ECharSet
127  {
130  {
131  LimitedGAMSCharSet = 0,
132  AnyChar = 1
133  };
134  };
137  {
140  {
141  Off = 0,
142  On = 1
143  };
144  };
146  struct EDFormat
147  {
150  {
151  Slash = 0,
152  Dot = 1,
153  Dash = 2
154  };
155  };
157  struct EDigit
158  {
161  {
162  OffDigit = 0,
163  OnDigit = 1
164  };
165  };
167  struct EDumpOpt
168  {
171  {
172  No = 0,
173  RefDataOriginalSetElementNames = 1,
174  RefDataNewSetElementNames = 2,
175  RefDataNewSetElementNamesDropSymbolText = 3,
176  RefSymbol = 4,
177  Deprecated_10 = 10,
178  InputFileWOComments = 11,
179  Deprecated_12 = 12,
180  Deprecated_19 = 19,
181  Deprecated_20 = 20,
182  InputFileWithComments = 21
183  };
184  };
186  struct EDumpParms
187  {
190  {
191  No = 0,
192  AcceptedParameters = 1,
193  FileOperationsAcceptedParameters = 2
194  };
195  };
198  {
201  {
202  OffECImplicitLoad = 0,
203  OnECImplicitLoad = 1
204  };
205  };
207  struct EEmpty
208  {
211  {
212  OffEmpty = 0,
213  OnEmpty = 1
214  };
215  };
217  struct EErrMsg
218  {
221  {
222  EndOfCompilerListing = 0,
223  FollowingError = 1,
224  Suppress = 2
225  };
226  };
228  struct EExecMode
229  {
232  {
233  EverythingAllowed = 0,
234  InteractiveShellsProhibited = 1,
235  CallAndExecuteProhibited = 2,
236  EchoAndPutOnlyToWorkdir = 3,
237  EchoAndPutProhibited = 4
238  };
239  };
241  struct EFDOpt
242  {
245  {
246  GHAnalyticHNumericGradScale = 0,
247  GHAnalyticHNumericFuncScale = 1,
248  GAnalyticFHNumericGradScale = 2,
249  GAnalyticFHNumericFuncScale = 3,
250  FGHNumericScale = 4,
251  GHAnalyticHNumericGradNoScale = 10,
252  GHAnalyticHNumericFuncNoScale = 11,
253  GAnalyticFHNumericGradNoScale = 12,
254  GAnalyticFHNumericFuncNoScale = 13,
255  FGHNumericNoScale = 14
256  };
257  };
259  struct EFileCase
260  {
263  {
264  DefaultCase = 0,
265  UpperCase = 1,
266  LowerCase = 2,
267  UpperCaseFileOnly = 3,
268  LowerCaseFileOnly = 4
269  };
270  };
272  struct EFiltered
273  {
276  {
277  OffFiltered = 0,
278  OnFiltered = 1
279  };
280  };
282  struct EForceWork
283  {
286  {
287  NoTranslation = 0,
288  TryTranslation = 1
289  };
290  };
293  {
296  {
297  Off = 0,
298  On = 1
299  };
300  };
303  {
306  {
307  DoNotCompressGDX = 0,
308  CompressGDX = 1
309  };
310  };
312  struct EgdxConvert
313  {
316  {
317  Version5 = 0,
318  Version6 = 1,
319  Version7 = 2
320  };
321  };
323  struct EgdxUels
324  {
327  {
328  squeezed = 0,
329  full = 1
330  };
331  };
333  struct EHoldFixed
334  {
337  {
338  FixedVarsNotTreatedAsConstants = 0,
339  FixedVarsTreatedAsConstants = 1
340  };
341  };
344  {
347  {
348  Off = 0,
349  On = 1
350  };
351  };
354  {
357  {
358  NoInteraction = 0,
359  AllowInteraction = 1
360  };
361  };
363  struct EIntVarUp
364  {
367  {
368  INF = 0,
369  Pass100ToSolver = 1,
370  INFandLog = 2,
371  Pass100ToSolverAndError = 3
372  };
373  };
375  struct EKeep
376  {
379  {
380  DeleteProcDir = 0,
381  KeepProcDir = 1
382  };
383  };
385  struct EListing
386  {
389  {
390  OffListing = 0,
391  OnListing = 1
392  };
393  };
395  struct ELogLine
396  {
399  {
400  NoTracing = 0,
401  MinimumTracing = 1,
402  Automatic = 2
403  };
404  };
407  {
410  {
411  Off = 0,
412  On = 1
413  };
414  };
417  {
420  {
421  AllowNewVarEqu = 0,
422  DoNotAllowNewVarEqu = 1
423  };
424  };
426  struct EOn115
427  {
430  {
431  NoMessages = 0,
432  IssueMessages = 1
433  };
434  };
436  struct EPageContr
437  {
440  {
441  NoPageContrWithPadding = 0,
442  FortranStyle = 1,
443  NoPageContrNoPadding = 2,
444  FormfeedCharNewPage = 3
445  };
446  };
449  {
452  {
453  Off = 0,
454  On = 1
455  };
456  };
459  {
462  {
463  Off = 0,
464  On = 1
465  };
466  };
469  {
472  {
473  Off = 0,
474  On = 1
475  };
476  };
478  struct EPutNR
479  {
482  {
483  ForE = 0,
484  Rounded = 1,
485  Scientific = 2,
486  RoundedFloatingDec = 3,
487  ForEFloatingDec = 4
488  };
489  };
491  struct EPyMultInst
492  {
495  {
496  Single = 0,
497  Multi = 1
498  };
499  };
502  {
505  {
506  ActualLineNumber = 0,
507  StatementStart = 1
508  };
509  };
511  struct ESavePoint
512  {
515  {
516  NoPointFile = 0,
517  LastSolvePointFile = 1,
518  EverySolvePointFile = 2,
519  LastSolvePointFileScrDir = 3,
520  EverySolvePointFileScrDir = 4
521  };
522  };
525  {
528  {
529  InternalAccounting = 0,
530  RSS = 1,
531  VSS = 2
532  };
533  };
535  struct ESolPrint
536  {
539  {
540  RemoveSolLstFollowingSolves = 0,
541  IncludeSolLstFollowingSolves = 1,
542  SuppressAllSolInfo = 2
543  };
544  };
546  struct ESolveLink
547  {
550  {
551  ChainScript = 0,
552  CallScript = 1,
553  CallModule = 2,
554  AsyncGrid = 3,
555  AsyncSimulate = 4,
556  LoadLibrary = 5,
557  LoadLibraryAsync = 6,
558  LoadLibraryAsyncSimulate = 7
559  };
560  };
562  struct EStepSum
563  {
566  {
567  NoStepSummmary = 0,
568  StepSummary = 1
569  };
570  };
573  {
576  {
577  FirstRecord = 0,
578  Error = 1
579  };
580  };
582  struct EStringChk
583  {
586  {
587  NoError = 0,
588  Error = 1,
589  NoErrorRemoveSymbol = 2
590  };
591  };
594  {
597  {
598  OffSuffixDLVars = 0,
599  OnSuffixDLVars = 1
600  };
601  };
604  {
607  {
608  OffSuffixAlgebraVars = 0,
609  OnSuffixAlgebraVars = 1
610  };
611  };
613  struct ESuppress
614  {
617  {
618  StandardCompilerListing = 0,
619  SuppressCompilerListing = 1
620  };
621  };
623  struct ESys10
624  {
627  {
628  Disable = 0,
629  Enable = 1
630  };
631  };
633  struct ESys11
634  {
637  {
638  AutomaticOptimization = 0,
639  NoOptimization = 1,
640  AlwaysOptimize = 2
641  };
642  };
644  struct ESysOut
645  {
648  {
649  SuppressAdditionalSolverOutput = 0,
650  IncludeAdditionalSolverOutput = 1
651  };
652  };
654  struct ETFormat
655  {
658  {
659  Colon = 0,
660  Dot = 1
661  };
662  };
664  struct ETraceOpt
665  {
668  {
669  SolverAndGAMSStepTraceWOHeaders = 0,
670  SolverAndGAMSStepTrace = 1,
671  SolverStepTraceOnly = 2,
672  TraceFileFormatGAMSPerformanceWorld = 3,
673  TraceFileFormatSupportingNLPEC = 4,
674  TraceFileWithAllAvailableTraceFields = 5
675  };
676  };
678  struct EZeroResRep
679  {
682  {
683  NoWarning = 0,
684  IssueWarning = 1
685  };
686  };
687 
690 
692  static const char* gamsBuild();
693 
695  static const char* gamsVersion();
696 
699  LogId logID();
700 
702  void writeOptionFile(const std::string& optFileName);
703 
705  void setAllModelTypes(const std::string& solver);
706 
709 
711  void addInputDir(const std::string value);
712 
714  std::string getInputDir(const int index);
715 
717  void setInputDir(const std::string value, const int index);
718 
720  void removeInputDir(const int index);
721 
723  void setDefine(const std::string &key, const std::string &value);
724 
726  std::string getDefine(const std::string& key);
727 
729  bool removeDefine(const std::string& key);
730 
732  std::string gdx();
733 
735  void setGdx(const std::string& value);
736 
739 
742 
744  static EAction::EActionEnum eActionFromCode(const std::string &str);
745 
748 
751 
754 
757 
760 
763 
766 
769 
771  double bratio();
772 
774  void setBratio(const double value);
775 
778 
781 
783  int lstCase();
784 
786  void setLstCase(const int value);
787 
789  int cErr();
790 
792  void setCErr(const int value);
793 
796 
799 
802 
805 
807  std::string decryptKey();
808 
810  void setDecryptKey(const std::string& value);
811 
814 
817 
819  static std::string eDigitText(GAMSOptions::EDigit::EDigitEnum type);
820 
822  static std::string eDigitCode(GAMSOptions::EDigit::EDigitEnum type);
823 
825  static EDigit::EDigitEnum eDigitFromCode(const std::string &str);
826 
829 
832 
834  int domLim();
835 
837  void setDomLim(const int value);
838 
841 
844 
846  std::string dumpOptGDX();
847 
849  void setDumpOptGDX(const std::string& value);
850 
853 
856 
858  std::string dumpParmsLogPrefix();
859 
861  void setDumpParmsLogPrefix(const std::string& value);
862 
865 
868 
871 
874 
877 
879  static std::string eEmptyText(GAMSOptions::EEmpty::EEmptyEnum type);
880 
882  static std::string eEmptyCode(GAMSOptions::EEmpty::EEmptyEnum type);
883 
885  static EEmpty::EEmptyEnum eEmptyFromCode(const std::string &str);
886 
889 
892 
894  std::string encryptKey();
895 
897  void setEncryptKey(const std::string& value);
898 
900  std::string eolCom();
901 
903  void setEolCom(const std::string& value);
904 
907 
910 
912  int errorLog();
913 
915  void setErrorLog(const int value);
916 
918  double eTLim();
919 
921  void setETLim(const double value);
922 
925 
928 
930  std::string expand();
931 
933  void setExpand(const std::string& value);
934 
936  double fDDelta();
937 
939  void setFDDelta(const double value);
940 
943 
946 
948  std::string fErr();
949 
951  void setFErr(const std::string& value);
952 
955 
958 
960  std::string fileStem();
961 
963  void setFileStem(const std::string& value);
964 
966  std::string fileStemApFromEnv();
967 
969  void setFileStemApFromEnv(const std::string& value);
970 
973 
976 
978  static EFiltered::EFilteredEnum eFilteredFromCode(const std::string &str);
979 
982 
985 
988 
990  void setForceOptFile(const int value);
991 
994 
997 
999  int forLim();
1000 
1002  void setForLim(const int value);
1003 
1006 
1009 
1012 
1015 
1018 
1021 
1023  static EgdxConvert::EgdxConvertEnum egdxConvertFromCode(const std::string &str);
1024 
1027 
1030 
1033 
1036 
1038  static EgdxUels::EgdxUelsEnum egdxUelsFromCode(const std::string &str);
1039 
1042 
1045 
1047  std::string gridDir();
1048 
1050  void setGridDir(const std::string& value);
1051 
1053  std::string gridScript();
1054 
1056  void setGridScript(const std::string& value);
1057 
1059  double heapLimit();
1060 
1062  void setHeapLimit(const double value);
1063 
1066 
1069 
1072 
1075 
1077  std::string iDCGDXInput();
1078 
1080  void setIDCGDXInput(const std::string& value);
1081 
1083  std::string iDCGDXOutput();
1084 
1086  void setIDCGDXOutput(const std::string& value);
1087 
1089  std::string inlineCom();
1090 
1092  void setInlineCom(const std::string& value);
1093 
1095  int integer1();
1096 
1098  void setInteger1(const int value);
1099 
1101  int integer2();
1102 
1104  void setInteger2(const int value);
1105 
1107  int integer3();
1108 
1110  void setInteger3(const int value);
1111 
1113  int integer4();
1114 
1116  void setInteger4(const int value);
1117 
1119  int integer5();
1120 
1122  void setInteger5(const int value);
1123 
1126 
1129 
1132 
1135 
1137  int iterLim();
1138 
1140  void setIterLim(const int value);
1141 
1143  std::string jobTrace();
1144 
1146  void setJobTrace(const std::string& value);
1147 
1150 
1153 
1155  std::string libIncDir();
1156 
1158  void setLibIncDir(const std::string& value);
1159 
1161  std::string license();
1162 
1164  void setLicense(const std::string& value);
1165 
1167  int limCol();
1168 
1170  void setLimCol(const int value);
1171 
1173  int limRow();
1174 
1176  void setLimRow(const int value);
1177 
1180 
1183 
1185  static EListing::EListingEnum eListingFromCode(const std::string &str);
1186 
1189 
1192 
1195 
1198 
1201 
1204 
1207 
1209  void setMaxExecError(const int value);
1210 
1212  int maxProcDir();
1213 
1215  void setMaxProcDir(const int value);
1216 
1218  std::string multi();
1219 
1221  void setMulti(const std::string& value);
1222 
1224  int nodLim();
1225 
1227  void setNodLim(const int value);
1228 
1231 
1234 
1237 
1240 
1242  double optCA();
1243 
1245  void setOptCA(const double value);
1246 
1248  double optCR();
1249 
1251  void setOptCR(const double value);
1252 
1254  std::string optDir();
1255 
1257  void setOptDir(const std::string& value);
1258 
1260  int optFile();
1261 
1263  void setOptFile(const int value);
1264 
1266  std::string output();
1267 
1269  void setOutput(const std::string& value);
1270 
1273 
1276 
1278  int pageSize();
1279 
1281  void setPageSize(const int value);
1282 
1284  int pageWidth();
1285 
1287  void setPageWidth(const int value);
1288 
1290  std::string pLicense();
1291 
1293  void setPLicense(const std::string& value);
1294 
1297 
1300 
1303 
1306 
1309 
1312 
1315 
1317  void setProcTreeMemTicks(const int value);
1318 
1320  int profile();
1321 
1323  void setProfile(const int value);
1324 
1326  std::string profileFile();
1327 
1329  void setProfileFile(const std::string& value);
1330 
1332  double profileTol();
1333 
1335  void setProfileTol(const double value);
1336 
1338  std::string putDir();
1339 
1341  void setPutDir(const std::string& value);
1342 
1344  int putND();
1345 
1347  void setPutND(const int value);
1348 
1351 
1354 
1356  int putPS();
1357 
1359  void setPutPS(const int value);
1360 
1362  int putPW();
1363 
1365  void setPutPW(const int value);
1366 
1369 
1372 
1374  std::string reference();
1375 
1377  void setReference(const std::string& value);
1378 
1381 
1384 
1387 
1390 
1393 
1395  double resLim();
1396 
1398  void setResLim(const double value);
1399 
1402 
1405 
1407  std::string scriptExit();
1408 
1410  void setScriptExit(const std::string& value);
1411 
1413  int seed();
1414 
1416  void setSeed(const int value);
1417 
1420 
1423 
1426 
1429 
1432 
1435 
1438 
1441 
1444 
1447 
1450 
1453 
1456 
1459 
1462 
1465 
1468 
1471 
1474 
1477 
1480 
1483 
1486 
1489 
1491  std::string symbol();
1492 
1494  void setSymbol(const std::string& value);
1495 
1497  std::string symPrefix();
1498 
1500  void setSymPrefix(const std::string& value);
1501 
1504 
1507 
1510 
1513 
1515  int sys12();
1516 
1518  void setSys12(const int value);
1519 
1521  std::string sysIncDir();
1522 
1524  void setSysIncDir(const std::string& value);
1525 
1528 
1531 
1533  int tabIn();
1534 
1536  void setTabIn(const int value);
1537 
1540 
1543 
1545  int threads();
1546 
1548  void setThreads(const int value);
1549 
1552 
1554  void setThreadsAsync(const int value);
1555 
1557  int timer();
1558 
1560  void setTimer(const int value);
1561 
1563  std::string trace();
1564 
1566  void setTrace(const std::string& value);
1567 
1569  int traceLevel();
1570 
1572  void setTraceLevel(const int value);
1573 
1576 
1579 
1581  std::string user1();
1582 
1584  void setUser1(const std::string& value);
1585 
1587  std::string user2();
1588 
1590  void setUser2(const std::string& value);
1591 
1593  std::string user3();
1594 
1596  void setUser3(const std::string& value);
1597 
1599  std::string user4();
1600 
1602  void setUser4(const std::string& value);
1603 
1605  std::string user5();
1606 
1608  void setUser5(const std::string& value);
1609 
1611  int warnings();
1612 
1614  void setWarnings(const int value);
1615 
1617  double workFactor();
1618 
1620  void setWorkFactor(const double value);
1621 
1623  double workSpace();
1624 
1626  void setWorkSpace(const double value);
1627 
1629  double zeroRes();
1630 
1632  void setZeroRes(const double value);
1633 
1636 
1639 
1641  std::string LP();
1642 
1644  void setLP(const std::string& value);
1645 
1647  std::string MIP();
1648 
1650  void setMIP(const std::string& value);
1651 
1653  std::string RMIP();
1654 
1656  void setRMIP(const std::string& value);
1657 
1659  std::string NLP();
1660 
1662  void setNLP(const std::string& value);
1663 
1665  std::string MCP();
1666 
1668  void setMCP(const std::string& value);
1669 
1671  std::string MPEC();
1672 
1674  void setMPEC(const std::string& value);
1675 
1677  std::string RMPEC();
1678 
1680  void setRMPEC(const std::string& value);
1681 
1683  std::string CNS();
1684 
1686  void setCNS(const std::string& value);
1687 
1689  std::string DNLP();
1690 
1692  void setDNLP(const std::string& value);
1693 
1695  std::string RMINLP();
1696 
1698  void setRMINLP(const std::string& value);
1699 
1701  std::string MINLP();
1702 
1704  void setMINLP(const std::string& value);
1705 
1707  std::string QCP();
1708 
1710  void setQCP(const std::string& value);
1711 
1713  std::string MIQCP();
1714 
1716  void setMIQCP(const std::string& value);
1717 
1719  std::string RMIQCP();
1720 
1722  void setRMIQCP(const std::string& value);
1723 
1725  std::string EMP();
1726 
1728  void setEMP(const std::string& value);
1729 
1731  std::string getSolver(const std::string& modelType);
1732 
1734  void setSolver(const std::string& modelType, const std::string& solver);
1735 
1736 private:
1737  std::shared_ptr<GAMSOptionsImpl> mImpl;
1738  GAMSOptions(GAMSWorkspace workspace, const GAMSOptions* optFrom);
1739  GAMSOptions(GAMSWorkspace workspace, const std::string& optFile = "");
1740  int appendLog();
1741  void setAppendLog(const int value);
1742  std::string connectIn();
1743  void setConnectIn(const std::string& value);
1744  std::string connectOut();
1745  void setConnectOut(const std::string& value);
1746  std::string curDir();
1747  void setCurDir(const std::string& value);
1748  int debug();
1749  void setDebug(const int value);
1750  std::string docFile();
1751  void setDocFile(const std::string& value);
1752  std::string epsToZero();
1753  void setEpsToZero(const std::string& value);
1754  std::string errNam();
1755  void setErrNam(const std::string& value);
1756  int fSave();
1757  void setFSave(const int value);
1758  int g205();
1759  void setG205(const int value);
1760  std::string iDCGenerateGDX();
1761  void setIDCGenerateGDX(const std::string& value);
1762  std::string iDCGenerateGDXInput();
1763  void setIDCGenerateGDXInput(const std::string& value);
1764  std::string iDCGenerateGDXOutput();
1765  void setIDCGenerateGDXOutput(const std::string& value);
1766  std::string iDCGenerateJSON();
1767  void setIDCGenerateJSON(const std::string& value);
1768  std::string iDCJSON();
1769  void setIDCJSON(const std::string& value);
1770  int iDCProtect();
1771  void setIDCProtect(const int value);
1772  int iDE();
1773  void setIDE(const int value);
1774  std::string input();
1775  void setInput(const std::string& value);
1776  std::string logFile();
1777  void setLogFile(const std::string& value);
1778  int logOption();
1779  void setLogOption(const int value);
1780  int maxGenericFiles();
1781  void setMaxGenericFiles(const int value);
1782  int mCPRHoldfx();
1783  void setMCPRHoldfx(const int value);
1784  int multiPass();
1785  void setMultiPass(const int value);
1786  int noCr();
1787  void setNoCr(const int value);
1788  int opt();
1789  void setOpt(const int value);
1790  int pID2Error();
1791  void setPID2Error(const int value);
1792  std::string procDir();
1793  void setProcDir(const std::string& value);
1794  std::string procDirPath();
1795  void setProcDirPath(const std::string& value);
1796  int relPath();
1797  void setRelPath(const int value);
1798  std::string restart();
1799  void setRestart(const std::string& value);
1800  std::string restartNamed();
1801  void setRestartNamed(const std::string& value);
1802  std::string save();
1803  void setSave(const std::string& value);
1804  std::string saveObfuscate();
1805  void setSaveObfuscate(const std::string& value);
1806  std::string scrDir();
1807  void setScrDir(const std::string& value);
1808  std::string scrExt();
1809  void setScrExt(const std::string& value);
1810  std::string scriptFrst();
1811  void setScriptFrst(const std::string& value);
1812  std::string scriptNext();
1813  void setScriptNext(const std::string& value);
1814  std::string scrNam();
1815  void setScrNam(const std::string& value);
1816  int serverRun();
1817  void setServerRun(const int value);
1818  std::string solver();
1819  void setSolver(const std::string& value);
1820  std::string solverCntr();
1821  void setSolverCntr(const std::string& value);
1822  std::string solverDict();
1823  void setSolverDict(const std::string& value);
1824  std::string solverInst();
1825  void setSolverInst(const std::string& value);
1826  std::string solverMatr();
1827  void setSolverMatr(const std::string& value);
1828  std::string solverSolu();
1829  void setSolverSolu(const std::string& value);
1830  std::string solverStat();
1831  void setSolverStat(const std::string& value);
1832  std::string sparseRun();
1833  void setSparseRun(const std::string& value);
1834  std::string sqaCmex();
1835  void setSqaCmex(const std::string& value);
1836  std::string subSys();
1837  void setSubSys(const std::string& value);
1838  int sys14();
1839  void setSys14(const int value);
1840  int sys15();
1841  void setSys15(const int value);
1842  int sys16();
1843  void setSys16(const int value);
1844  int sys17();
1845  void setSys17(const int value);
1846  int sys18();
1847  void setSys18(const int value);
1848  int sys19();
1849  void setSys19(const int value);
1850  std::string sysDir();
1851  void setSysDir(const std::string& value);
1852  int useDLL();
1853  void setUseDLL(const int value);
1854  std::string workDir();
1855  void setWorkDir(const std::string& value);
1856  std::string xSave();
1857  void setXSave(const std::string& value);
1858  std::string xSaveObfuscate();
1859  void setXSaveObfuscate(const std::string& value);
1860 
1861 };
1862 }
1863 #endif // GAMSOPTIONS_H
1864 
Allow solver to interact via command line input.
Definition: gamsoptions.h:354
ECaseEnum
Output case option for LST file.
Definition: gamsoptions.h:120
void setNodLim(const int value)
Set Node limit in branch and bound tree.
void setProcTreeMemMonitor(const GAMSOptions::EProcTreeMemMonitor::EProcTreeMemMonitorEnum value)
Set Monitor the memory used by the GAMS process tree.
void setDFormat(const GAMSOptions::EDFormat::EDFormatEnum value)
Set Date format.
void setSolPrint(const GAMSOptions::ESolPrint::ESolPrintEnum value)
Set Solution report print option.
std::string gridDir()
Get Grid file directory.
std::string MIP()
Get default MIP solver.
GAMSOptions::EPrefixLoadPath::EPrefixLoadPathEnum prefixLoadPath()
Get Prepend GAMS system directory to library load path.
ESuffixAlgebraVarsEnum
Switch default for "$on/offSuffixAlgebraVars".
Definition: gamsoptions.h:607
std::string encryptKey()
Get Key to encrypt a text file using $encrypt.
double bratio()
Get Basis detection threshold.
void setFileCase(const GAMSOptions::EFileCase::EFileCaseEnum value)
Set Casing of file names and paths (put, gdx, ref, $include, etc.)
static EECImplicitLoad::EECImplicitLoadEnum eECImplicitLoadFromCode(const std::string &str)
Get Allow implicit loading of symbols from embedded code or not from std::string
void setOutput(const std::string &value)
Set Listing file name.
void setProfileFile(const std::string &value)
Set Write profile information to this file.
void setPutND(const int value)
Set Number of decimals for put files.
std::string iDCGDXInput()
Get GDX file name with data for implicit input.
GAMS parameter logging.
Definition: gamsoptions.h:187
void setPutNR(const GAMSOptions::EPutNR::EPutNREnum value)
Set Numeric round format for put files.
Options for finite differences.
Definition: gamsoptions.h:242
void setGridScript(const std::string &value)
Set Grid submission script.
GAMSOptions::EIntVarUp::EIntVarUpEnum intVarUp()
Get Set mode for default upper bounds on integer variables.
int warnings()
Get Number of warnings permitted before a run terminates.
std::string scriptExit()
Get Program or script to be executed at the end of a GAMS run.
int pageWidth()
Get Output file page width.
std::string fileStemApFromEnv()
Get Append a string read from an environment variable to the "FileStem".
ENoNewVarEquEnum
Triggers a compilation error when new equations or variable symbols are introduced.
Definition: gamsoptions.h:420
Prepend GAMS system directory to library load path.
Definition: gamsoptions.h:449
Output file append option.
Definition: gamsoptions.h:87
ESys10Enum
Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
Definition: gamsoptions.h:627
void setOn115(const GAMSOptions::EOn115::EOn115Enum value)
Set Generate errors for unknown unique element in an equation.
void setPreviousWork(const GAMSOptions::EPreviousWork::EPreviousWorkEnum value)
Set Indicator for writing workfile with previous workfile version.
void setSavePoint(const GAMSOptions::ESavePoint::ESavePointEnum value)
Set Save solver point in GDX file.
static std::string eDigitText(GAMSOptions::EDigit::EDigitEnum type)
Get Switch default for "$on/offDigit" as text.
std::string RMPEC()
Get default RMPEC solver.
void setNLP(const std::string &value)
Set default NLP solver.
GAMSOptions::EShowOSMemory::EShowOSMemoryEnum showOSMemory()
Get Show the memory usage reported by the Operating System instead of the internal counting.
std::string MCP()
Get default MCP solver.
void setAppendExpand(const GAMSOptions::EAppendExpand::EAppendExpandEnum value)
Set Expand file append option.
void setPutPS(const int value)
Set Page size for put files.
void setNoNewVarEqu(const GAMSOptions::ENoNewVarEqu::ENoNewVarEquEnum value)
Set Triggers a compilation error when new equations or variable symbols are introduced.
Indicator for writing workfile with previous workfile version.
Definition: gamsoptions.h:459
std::string output()
Get Listing file name.
void writeOptionFile(const std::string &optFileName)
Export options to an option file.
int tabIn()
Get Tab spacing.
EOn115Enum
Generate errors for unknown unique element in an equation.
Definition: gamsoptions.h:430
void setRMIQCP(const std::string &value)
Set default RMIQCP solver.
void setTFormat(const GAMSOptions::ETFormat::ETFormatEnum value)
Set Time format.
GAMSOptions::ESavePoint::ESavePointEnum savePoint()
Get Save solver point in GDX file.
std::string multi()
Get Switch default for "$on/offMulti[R]".
std::string profileFile()
Get Write profile information to this file.
Character set flag.
Definition: gamsoptions.h:127
Treat fixed variables as constants.
Definition: gamsoptions.h:334
Allow HoldFixed for models solved asynchronously as well.
Definition: gamsoptions.h:344
GAMSOptions::ETraceOpt::ETraceOptEnum traceOpt()
Get Trace file format option.
void setSymPrefix(const std::string &value)
Set Prefix all symbols encountered during compilation by the specified string in work file.
int integer1()
Get Integer communication cell N.
EExecModeEnum
Limits on external programs that are allowed to be executed.
Definition: gamsoptions.h:232
static EListing::EListingEnum eListingFromCode(const std::string &str)
Get Switch default for "$on/offListing" from std::string
EFilteredEnum
Switch default for "$on/offFiltered".
Definition: gamsoptions.h:276
Switch default for "$on/offSuffixAlgebraVars".
Definition: gamsoptions.h:604
Compression of generated GDX file.
Definition: gamsoptions.h:303
int maxExecError()
Get Execution time error limit.
int timer()
Get Instruction timer threshold in milli seconds.
bool removeDefine(const std::string &key)
Remove a double-dash option.
GAMSOptions::EDumpParms::EDumpParmsEnum dumpParms()
Get GAMS parameter logging.
EAsyncSolLstEnum
Print solution listing when asynchronous solve (Grid or Threads) is used.
Definition: gamsoptions.h:100
void setAllModelTypes(const std::string &solver)
Set the solver for all model types the solver can handle.
int integer2()
Get Integer communication cell N.
void setECImplicitLoad(const GAMSOptions::EECImplicitLoad::EECImplicitLoadEnum value)
Set Allow implicit loading of symbols from embedded code or not.
std::string optDir()
Get Option file directory.
void setLicense(const std::string &value)
Set Use alternative license file.
EstrictSingletonEnum
Error if assignment to singleton set has multiple elements.
Definition: gamsoptions.h:576
static std::string eReferenceLineNoText(GAMSOptions::EReferenceLineNo::EReferenceLineNoEnum type)
Get Controls the line numbers written to a reference file as text.
void setReferenceLineNo(const GAMSOptions::EReferenceLineNo::EReferenceLineNoEnum value)
Set Controls the line numbers written to a reference file.
void setCaptureModelInstance(const GAMSOptions::ECaptureModelInstance::ECaptureModelInstanceEnum value)
Set Switch to capture all model instances within a run.
void setSuffixDLVars(const GAMSOptions::ESuffixDLVars::ESuffixDLVarsEnum value)
Set Switch default for "$on/offSuffixDLVars".
std::string RMIQCP()
Get default RMIQCP solver.
EECImplicitLoadEnum
Allow implicit loading of symbols from embedded code or not.
Definition: gamsoptions.h:201
EProcTreeMemMonitorEnum
Monitor the memory used by the GAMS process tree.
Definition: gamsoptions.h:472
void setSymbol(const std::string &value)
Set Symbol table file.
void setDumpOptGDX(const std::string &value)
Set Defines a GDX file name stem created when using DumpOpt.
int domLim()
Get Domain violation limit solver default.
void setFileStemApFromEnv(const std::string &value)
Set Append a string read from an environment variable to the "FileStem".
void setUser3(const std::string &value)
Set User string N.
void setMIQCP(const std::string &value)
Set default MIQCP solver.
GAMSOptions::ETFormat::ETFormatEnum tFormat()
Get Time format.
void setKeep(const GAMSOptions::EKeep::EKeepEnum value)
Set Controls keeping or deletion of process directory and scratch files.
GAMS/Python Multiple Instance Interpreter.
Definition: gamsoptions.h:492
Numeric round format for put files.
Definition: gamsoptions.h:479
Switch default for "$on/offSuffixDLVars".
Definition: gamsoptions.h:594
void setMaxExecError(const int value)
Set Execution time error limit.
int integer3()
Get Integer communication cell N.
void setGdx(const std::string &value)
Set GDX file name.
int procTreeMemTicks()
Get Set wait interval between memory monitor checks: ticks = milliseconds.
Triggers a compilation error when new equations or variable symbols are introduced.
Definition: gamsoptions.h:417
EDigitEnum
Switch default for "$on/offDigit".
Definition: gamsoptions.h:161
GAMSOptions::EstrictSingleton::EstrictSingletonEnum strictSingleton()
Get Error if assignment to singleton set has multiple elements.
static const char * gamsBuild()
Get GAMS build information.
static std::string egdxConvertText(GAMSOptions::EgdxConvert::EgdxConvertEnum type)
Get Version of GDX files generated (for backward compatibility) as text.
int lstCase()
Get Output case option for LST file.
Unload labels or UELs to GDX either squeezed or full.
Definition: gamsoptions.h:324
EKeepEnum
Controls keeping or deletion of process directory and scratch files.
Definition: gamsoptions.h:379
void setGridDir(const std::string &value)
Set Grid file directory.
void setQCP(const std::string &value)
Set default QCP solver.
ELogLineEnum
Amount of line tracing to the log file.
Definition: gamsoptions.h:399
EEmptyEnum
Switch default for "$on/offEmpty".
Definition: gamsoptions.h:211
EActionEnum
GAMS processing request.
Definition: gamsoptions.h:66
int nodLim()
Get Node limit in branch and bound tree.
static std::string eSuffixDLVarsCode(GAMSOptions::ESuffixDLVars::ESuffixDLVarsEnum type)
Get Switch default for "$on/offSuffixDLVars" as code.
GAMSOptions::EFDOpt::EFDOptEnum fDOpt()
Get Options for finite differences.
void setOptFile(const int value)
Set Default option file.
GAMSOptions::EAppendExpand::EAppendExpandEnum appendExpand()
Get Expand file append option.
GAMSOptions::EEmpty::EEmptyEnum empty()
Get Switch default for "$on/offEmpty".
GAMSOptions::ESolPrint::ESolPrintEnum solPrint()
Get Solution report print option.
EStringChkEnum
String substitution options.
Definition: gamsoptions.h:586
static std::string eSuffixAlgebraVarsText(GAMSOptions::ESuffixAlgebraVars::ESuffixAlgebraVarsEnum type)
Get Switch default for "$on/offSuffixAlgebraVars" as text.
double zeroRes()
Get The results of certain operations will be set to zero if abs(result) LE ZeroRes.
void setCheckErrorLevel(const GAMSOptions::ECheckErrorLevel::ECheckErrorLevelEnum value)
Set Check errorLevel automatically after executing external program.
std::string user4()
Get User string N.
static std::string eECImplicitLoadCode(GAMSOptions::EECImplicitLoad::EECImplicitLoadEnum type)
Get Allow implicit loading of symbols from embedded code or not as code.
Free external resources at the end of each embedded Python code blocks.
Definition: gamsoptions.h:293
void setOptCA(const double value)
Set Absolute Optimality criterion solver default.
GAMSOptions::EExecMode::EExecModeEnum execMode()
Get Limits on external programs that are allowed to be executed.
void setInteractiveSolver(const GAMSOptions::EInteractiveSolver::EInteractiveSolverEnum value)
Set Allow solver to interact via command line input.
void setInteger5(const int value)
Set Integer communication cell N.
Switch to capture all model instances within a run.
Definition: gamsoptions.h:107
int limRow()
Get Maximum number of rows listed in one equation block.
std::string jobTrace()
Get Job trace string to be written to the trace file at the end of a GAMS job.
GAMSOptions::EPyMultInst::EPyMultInstEnum pyMultInst()
Get GAMS/Python Multiple Instance Interpreter.
void setDumpOpt(const GAMSOptions::EDumpOpt::EDumpOptEnum value)
Set Writes preprocessed input to the file input.dmp.
GAMSOptions::EPreviousWork::EPreviousWorkEnum previousWork()
Get Indicator for writing workfile with previous workfile version.
void setFiltered(const GAMSOptions::EFiltered::EFilteredEnum value)
Set Switch default for "$on/offFiltered".
void setSys10(const GAMSOptions::ESys10::ESys10Enum value)
Set Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
void setResLim(const double value)
Set Wall-clock time limit for solver.
void setstrictSingleton(const GAMSOptions::EstrictSingleton::EstrictSingletonEnum value)
Set Error if assignment to singleton set has multiple elements.
void setCharSet(const GAMSOptions::ECharSet::ECharSetEnum value)
Set Character set flag.
Definition: gams.h:91
int optFile()
Get Default option file.
ESolPrintEnum
Solution report print option.
Definition: gamsoptions.h:539
static EFiltered::EFilteredEnum eFilteredFromCode(const std::string &str)
Get Switch default for "$on/offFiltered" from std::string
std::string user5()
Get User string N.
void setForceWork(const GAMSOptions::EForceWork::EForceWorkEnum value)
Set Force GAMS to process a save file created with a newer GAMS version or with execution errors.
ECaptureModelInstanceEnum
Switch to capture all model instances within a run.
Definition: gamsoptions.h:110
Write title of LST file all left aligned.
Definition: gamsoptions.h:407
std::string DNLP()
Get default DNLP solver.
GAMSOptions::EErrMsg::EErrMsgEnum errMsg()
Get Placing of compilation error messages.
double heapLimit()
Get Maximum Heap size allowed in MB.
void setZeroRes(const double value)
Set The results of certain operations will be set to zero if abs(result) LE ZeroRes.
std::string putDir()
Get Put file directory.
void setDecryptKey(const std::string &value)
Set Key to decrypt a text file that was encrypted via $encrypt.
void setRMPEC(const std::string &value)
Set default RMPEC solver.
void setFreeEmbeddedPython(const GAMSOptions::EFreeEmbeddedPython::EFreeEmbeddedPythonEnum value)
Set Free external resources at the end of each embedded Python code blocks.
GAMSOptions::ESys10::ESys10Enum sys10()
Get Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
std::string symbol()
Get Symbol table file.
void setSolver(const std::string &modelType, const std::string &solver)
Get solver by model type.
void setStepSum(const GAMSOptions::EStepSum::EStepSumEnum value)
Set Summary of computing resources used by job steps.
void setEMP(const std::string &value)
Set default EMP solver.
GAMSOptions::ECharSet::ECharSetEnum charSet()
Get Character set flag.
static std::string eEmptyCode(GAMSOptions::EEmpty::EEmptyEnum type)
Get Switch default for "$on/offEmpty" as code.
std::string gdx()
Get GDX file name.
EHoldFixedAsyncEnum
Allow HoldFixed for models solved asynchronously as well.
Definition: gamsoptions.h:347
void setHeapLimit(const double value)
Set Maximum Heap size allowed in MB.
EZeroResRepEnum
Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
Definition: gamsoptions.h:682
int putPS()
Get Page size for put files.
int threadsAsync()
Get Limit on number of threads to be used for asynchronous solves (solveLink=6)
GAMSOptions::EgdxUels::EgdxUelsEnum gdxUels()
Get Unload labels or UELs to GDX either squeezed or full.
void setWorkSpace(const double value)
Set Work space for some solvers in MB.
EPrefixLoadPathEnum
Prepend GAMS system directory to library load path.
Definition: gamsoptions.h:452
void setMPEC(const std::string &value)
Set default MPEC solver.
Compiler listing option.
Definition: gamsoptions.h:614
GAMSOptions::ELstTitleLeftAligned::ELstTitleLeftAlignedEnum lstTitleLeftAligned()
Get Write title of LST file all left aligned.
Print solution listing when asynchronous solve (Grid or Threads) is used.
Definition: gamsoptions.h:97
Writes preprocessed input to the file input.dmp.
Definition: gamsoptions.h:168
ESavePointEnum
Save solver point in GDX file.
Definition: gamsoptions.h:515
std::string MINLP()
Get default MINLP solver.
GAMSOptions::ESys11::ESys11Enum sys11()
Get Dynamic resorting if indices in assignment/data statements are not in natural order.
EReferenceLineNoEnum
Controls the line numbers written to a reference file.
Definition: gamsoptions.h:505
ESys11Enum
Dynamic resorting if indices in assignment/data statements are not in natural order.
Definition: gamsoptions.h:637
std::string pLicense()
Get Privacy license file name.
void setSuppress(const GAMSOptions::ESuppress::ESuppressEnum value)
Set Compiler listing option.
int integer5()
Get Integer communication cell N.
void setPLicense(const std::string &value)
Set Privacy license file name.
std::string reference()
Get Symbol reference file.
static std::string eFilteredText(GAMSOptions::EFiltered::EFilteredEnum type)
Get Switch default for "$on/offFiltered" as text.
EAppendExpandEnum
Expand file append option.
Definition: gamsoptions.h:80
Expand file append option.
Definition: gamsoptions.h:77
void setHoldFixed(const GAMSOptions::EHoldFixed::EHoldFixedEnum value)
Set Treat fixed variables as constants.
std::string trace()
Get Trace file name.
void setETLim(const double value)
Set Elapsed time limit in seconds.
GAMSOptions::EFiltered::EFilteredEnum filtered()
Get Switch default for "$on/offFiltered".
void setHoldFixedAsync(const GAMSOptions::EHoldFixedAsync::EHoldFixedAsyncEnum value)
Set Allow HoldFixed for models solved asynchronously as well.
static EAction::EActionEnum eActionFromCode(const std::string &str)
Get GAMS processing request from std::string
void setLimRow(const int value)
Set Maximum number of rows listed in one equation block.
std::string license()
Get Use alternative license file.
ESuppressEnum
Compiler listing option.
Definition: gamsoptions.h:617
void setProfileTol(const double value)
Set Minimum time a statement must use to appear in profile generated output.
void setSysOut(const GAMSOptions::ESysOut::ESysOutEnum value)
Set Solver Status file reporting option.
GAMSOptions::EPutNR::EPutNREnum putNR()
Get Numeric round format for put files.
static std::string egdxUelsText(GAMSOptions::EgdxUels::EgdxUelsEnum type)
Get Unload labels or UELs to GDX either squeezed or full as text.
std::string dumpParmsLogPrefix()
Get Prefix of lines triggered by DumpParms>1.
std::string inlineCom()
Get Switch default for "$on/offInline" and "$inlineCom".
void setListing(const GAMSOptions::EListing::EListingEnum value)
Set Switch default for "$on/offListing".
EFileCaseEnum
Casing of file names and paths (put, gdx, ref, $include, etc.)
Definition: gamsoptions.h:263
Output file page control option.
Definition: gamsoptions.h:437
void setEncryptKey(const std::string &value)
Set Key to encrypt a text file using $encrypt.
GAMSOptions::EgdxConvert::EgdxConvertEnum gdxConvert()
Get Version of GDX files generated (for backward compatibility)
EDumpParmsEnum
GAMS parameter logging.
Definition: gamsoptions.h:190
GAMSOptions::ESuffixDLVars::ESuffixDLVarsEnum suffixDLVars()
Get Switch default for "$on/offSuffixDLVars".
static std::string egdxUelsCode(GAMSOptions::EgdxUels::EgdxUelsEnum type)
Get Unload labels or UELs to GDX either squeezed or full as code.
GAMSOptions::EStringChk::EStringChkEnum stringChk()
Get String substitution options.
Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
Definition: gamsoptions.h:624
int iterLim()
Get Iteration limit of solver.
GAMSOptions::EAction::EActionEnum action()
Get GAMS processing request.
void setPageContr(const GAMSOptions::EPageContr::EPageContrEnum value)
Set Output file page control option.
GAMSOptions::EStepSum::EStepSumEnum stepSum()
Get Summary of computing resources used by job steps.
void setSysIncDir(const std::string &value)
Set SysInclude directory.
GAMSOptions::EHoldFixed::EHoldFixedEnum holdFixed()
Get Treat fixed variables as constants.
std::string MPEC()
Get default MPEC solver.
static EDigit::EDigitEnum eDigitFromCode(const std::string &str)
Get Switch default for "$on/offDigit" from std::string
EListingEnum
Switch default for "$on/offListing".
Definition: gamsoptions.h:389
void setEmpty(const GAMSOptions::EEmpty::EEmptyEnum value)
Set Switch default for "$on/offEmpty".
void setFDOpt(const GAMSOptions::EFDOpt::EFDOptEnum value)
Set Options for finite differences.
void setMulti(const std::string &value)
Set Switch default for "$on/offMulti[R]".
GAMSOptions::EReferenceLineNo::EReferenceLineNoEnum referenceLineNo()
Get Controls the line numbers written to a reference file.
Switch default for "$on/offDigit".
Definition: gamsoptions.h:158
void setPageSize(const int value)
Set Output file page size (=0 no paging)
void setTraceOpt(const GAMSOptions::ETraceOpt::ETraceOptEnum value)
Set Trace file format option.
Controls the line numbers written to a reference file.
Definition: gamsoptions.h:502
GAMSOptions::EKeep::EKeepEnum keep()
Get Controls keeping or deletion of process directory and scratch files.
Solver Status file reporting option.
Definition: gamsoptions.h:645
void addInputDir(const std::string value)
Add new inputdir at the end of the inputdir list.
Output case option for LST file.
Definition: gamsoptions.h:117
GAMSOptions::EECImplicitLoad::EECImplicitLoadEnum eCImplicitLoad()
Get Allow implicit loading of symbols from embedded code or not.
GAMS processing request.
Definition: gamsoptions.h:63
static std::string eSuffixAlgebraVarsCode(GAMSOptions::ESuffixAlgebraVars::ESuffixAlgebraVarsEnum type)
Get Switch default for "$on/offSuffixAlgebraVars" as code.
void setShowOSMemory(const GAMSOptions::EShowOSMemory::EShowOSMemoryEnum value)
Set Show the memory usage reported by the Operating System instead of the internal counting.
Limits on external programs that are allowed to be executed.
Definition: gamsoptions.h:229
std::string getDefine(const std::string &key)
Get value of previously set double-dash –key-value option pair.
void setStringChk(const GAMSOptions::EStringChk::EStringChkEnum value)
Set String substitution options.
void setLimCol(const int value)
Set Maximum number of columns listed in one variable block.
static EEmpty::EEmptyEnum eEmptyFromCode(const std::string &str)
Get Switch default for "$on/offEmpty" from std::string
Switch default for "$on/offListing".
Definition: gamsoptions.h:386
static std::string eReferenceLineNoCode(GAMSOptions::EReferenceLineNo::EReferenceLineNoEnum type)
Get Controls the line numbers written to a reference file as code.
void setDumpParms(const GAMSOptions::EDumpParms::EDumpParmsEnum value)
Set GAMS parameter logging.
std::string symPrefix()
Get Prefix all symbols encountered during compilation by the specified string in work file.
void setEolCom(const std::string &value)
Set Switch default for "$on/offEolCom" and "$eolCom".
Generate errors for unknown unique element in an equation.
Definition: gamsoptions.h:427
int traceLevel()
Get Modelstat/Solvestat threshold used in conjunction with action=GT.
int sys12()
Get Pass model with generation errors to solver.
std::string QCP()
Get default QCP solver.
static std::string eActionCode(GAMSOptions::EAction::EActionEnum type)
Get GAMS processing request as code.
EHoldFixedEnum
Treat fixed variables as constants.
Definition: gamsoptions.h:337
Save solver point in GDX file.
Definition: gamsoptions.h:512
static std::string eSuffixDLVarsText(GAMSOptions::ESuffixDLVars::ESuffixDLVarsEnum type)
Get Switch default for "$on/offSuffixDLVars" as text.
int putND()
Get Number of decimals for put files.
EPutNREnum
Numeric round format for put files.
Definition: gamsoptions.h:482
static std::string egdxConvertCode(GAMSOptions::EgdxConvert::EgdxConvertEnum type)
Get Version of GDX files generated (for backward compatibility) as code.
void setInteger4(const int value)
Set Integer communication cell N.
double eTLim()
Get Elapsed time limit in seconds.
GAMSOptions::EProcTreeMemMonitor::EProcTreeMemMonitorEnum procTreeMemMonitor()
Get Monitor the memory used by the GAMS process tree.
Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
Definition: gamsoptions.h:679
static ESuffixAlgebraVars::ESuffixAlgebraVarsEnum eSuffixAlgebraVarsFromCode(const std::string &str)
Get Switch default for "$on/offSuffixAlgebraVars" from std::string
void setScriptExit(const std::string &value)
Set Program or script to be executed at the end of a GAMS run.
Trace file format option.
Definition: gamsoptions.h:665
void setgdxUels(const GAMSOptions::EgdxUels::EgdxUelsEnum value)
Set Unload labels or UELs to GDX either squeezed or full.
std::string sysIncDir()
Get SysInclude directory.
GAMSOptions::ENoNewVarEqu::ENoNewVarEquEnum noNewVarEqu()
Get Triggers a compilation error when new equations or variable symbols are introduced.
int integer4()
Get Integer communication cell N.
double optCR()
Get Relative Optimality criterion solver default.
GAMSOptions::EForceWork::EForceWorkEnum forceWork()
Get Force GAMS to process a save file created with a newer GAMS version or with execution errors.
void setRMINLP(const std::string &value)
Set default RMINLP solver.
GAMSOptions::EAppendOut::EAppendOutEnum appendOut()
Get Output file append option.
std::string NLP()
Get default NLP solver.
int forLim()
Get GAMS looping limit.
ETraceOptEnum
Trace file format option.
Definition: gamsoptions.h:668
static EReferenceLineNo::EReferenceLineNoEnum eReferenceLineNoFromCode(const std::string &str)
Get Controls the line numbers written to a reference file from std::string
int threads()
Get Number of threads to be used by a solver.
String substitution options.
Definition: gamsoptions.h:583
ECharSetEnum
Character set flag.
Definition: gamsoptions.h:130
void setDigit(const GAMSOptions::EDigit::EDigitEnum value)
Set Switch default for "$on/offDigit".
void setPyMultInst(const GAMSOptions::EPyMultInst::EPyMultInstEnum value)
Set GAMS/Python Multiple Instance Interpreter.
Amount of line tracing to the log file.
Definition: gamsoptions.h:396
int maxProcDir()
Get Maximum number of 225* process directories.
void setUser5(const std::string &value)
Set User string N.
EAppendOutEnum
Output file append option.
Definition: gamsoptions.h:90
GAMSOptions::EgdxCompress::EgdxCompressEnum gdxCompress()
Get Compression of generated GDX file.
void setLibIncDir(const std::string &value)
Set LibInclude directory.
ECheckErrorLevelEnum
Check errorLevel automatically after executing external program.
Definition: gamsoptions.h:140
void setWorkFactor(const double value)
Set Memory Estimate multiplier for some solvers.
EPreviousWorkEnum
Indicator for writing workfile with previous workfile version.
Definition: gamsoptions.h:462
EFreeEmbeddedPythonEnum
Free external resources at the end of each embedded Python code blocks.
Definition: gamsoptions.h:296
void setMINLP(const std::string &value)
Set default MINLP solver.
void setProcTreeMemTicks(const int value)
Set Set wait interval between memory monitor checks: ticks = milliseconds.
void setIDCGDXOutput(const std::string &value)
Set GDX file name for data for implicit output.
ESysOutEnum
Solver Status file reporting option.
Definition: gamsoptions.h:648
GAMSOptions::EFreeEmbeddedPython::EFreeEmbeddedPythonEnum freeEmbeddedPython()
Get Free external resources at the end of each embedded Python code blocks.
Dynamic resorting if indices in assignment/data statements are not in natural order.
Definition: gamsoptions.h:634
void setDumpParmsLogPrefix(const std::string &value)
Set Prefix of lines triggered by DumpParms>1.
Solution report print option.
Definition: gamsoptions.h:536
std::string LP()
Get default LP solver.
GAMSOptions::ESolveLink::ESolveLinkEnum solveLink()
Get Solver link option.
static ESuffixDLVars::ESuffixDLVarsEnum eSuffixDLVarsFromCode(const std::string &str)
Get Switch default for "$on/offSuffixDLVars" from std::string
void setBratio(const double value)
Set Basis detection threshold.
static std::string eListingText(GAMSOptions::EListing::EListingEnum type)
Get Switch default for "$on/offListing" as text.
GAMSOptions::EFileCase::EFileCaseEnum fileCase()
Get Casing of file names and paths (put, gdx, ref, $include, etc.)
Force GAMS to process a save file created with a newer GAMS version or with execution errors.
Definition: gamsoptions.h:283
int putPW()
Get Page width for put files.
Check errorLevel automatically after executing external program.
Definition: gamsoptions.h:137
std::string MIQCP()
Get default MIQCP solver.
void setSys12(const int value)
Set Pass model with generation errors to solver.
EForceWorkEnum
Force GAMS to process a save file created with a newer GAMS version or with execution errors.
Definition: gamsoptions.h:286
std::string eolCom()
Get Switch default for "$on/offEolCom" and "$eolCom".
void setgdxCompress(const GAMSOptions::EgdxCompress::EgdxCompressEnum value)
Set Compression of generated GDX file.
void setCNS(const std::string &value)
Set default CNS solver.
void setZeroResRep(const GAMSOptions::EZeroResRep::EZeroResRepEnum value)
Set Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
double profileTol()
Get Minimum time a statement must use to appear in profile generated output.
void setOptDir(const std::string &value)
Set Option file directory.
std::string user3()
Get User string N.
EPyMultInstEnum
GAMS/Python Multiple Instance Interpreter.
Definition: gamsoptions.h:495
void setSeed(const int value)
Set Random number seed.
int seed()
Get Random number seed.
void setLogLine(const GAMSOptions::ELogLine::ELogLineEnum value)
Set Amount of line tracing to the log file.
ESuffixDLVarsEnum
Switch default for "$on/offSuffixDLVars".
Definition: gamsoptions.h:597
EIntVarUpEnum
Set mode for default upper bounds on integer variables.
Definition: gamsoptions.h:367
void setFileStem(const std::string &value)
Set Sets the file stem for output files which use the input file name as stem by default.
Set mode for default upper bounds on integer variables.
Definition: gamsoptions.h:364
void setFErr(const std::string &value)
Set Alternative error message file.
GAMSOptions::EHoldFixedAsync::EHoldFixedAsyncEnum holdFixedAsync()
Get Allow HoldFixed for models solved asynchronously as well.
std::string expand()
Get Expanded (include) input file name.
void setPutDir(const std::string &value)
Set Put file directory.
std::string user1()
Get User string N.
void setMCP(const std::string &value)
Set default MCP solver.
GAMSOptions::EPageContr::EPageContrEnum pageContr()
Get Output file page control option.
Switch default for "$on/offFiltered".
Definition: gamsoptions.h:273
GAMSOptions::EDFormat::EDFormatEnum dFormat()
Get Date format.
void setRMIP(const std::string &value)
Set default RMIP solver.
int forceOptFile()
Get Overwrites other option file section mechanism.
void setExpand(const std::string &value)
Set Expanded (include) input file name.
GAMSOptions::ECaptureModelInstance::ECaptureModelInstanceEnum captureModelInstance()
Get Switch to capture all model instances within a run.
void setDefine(const std::string &key, const std::string &value)
Set double-dash –key=value option pair.
ELstTitleLeftAlignedEnum
Write title of LST file all left aligned.
Definition: gamsoptions.h:410
std::string gridScript()
Get Grid submission script.
static EgdxConvert::EgdxConvertEnum egdxConvertFromCode(const std::string &str)
Get Version of GDX files generated (for backward compatibility) from std::string
std::string getSolver(const std::string &modelType)
Get solver by model type.
std::string user2()
Get User string N.
EPageContrEnum
Output file page control option.
Definition: gamsoptions.h:440
void setUser1(const std::string &value)
Set User string N.
std::string libIncDir()
Get LibInclude directory.
void setgdxConvert(const GAMSOptions::EgdxConvert::EgdxConvertEnum value)
Set Version of GDX files generated (for backward compatibility)
~GAMSOptions()
Destructor.
void setOptCR(const double value)
Set Relative Optimality criterion solver default.
static std::string eListingCode(GAMSOptions::EListing::EListingEnum type)
Get Switch default for "$on/offListing" as code.
std::string EMP()
Get default EMP solver.
static std::string eECImplicitLoadText(GAMSOptions::EECImplicitLoad::EECImplicitLoadEnum type)
Get Allow implicit loading of symbols from embedded code or not as text.
void setUser4(const std::string &value)
Set User string N.
Monitor the memory used by the GAMS process tree.
Definition: gamsoptions.h:469
void setInteger1(const int value)
Set Integer communication cell N.
EgdxUelsEnum
Unload labels or UELs to GDX either squeezed or full.
Definition: gamsoptions.h:327
void setErrMsg(const GAMSOptions::EErrMsg::EErrMsgEnum value)
Set Placing of compilation error messages.
Summary of computing resources used by job steps.
Definition: gamsoptions.h:563
GAMSOptions::EAsyncSolLst::EAsyncSolLstEnum asyncSolLst()
Get Print solution listing when asynchronous solve (Grid or Threads) is used.
Casing of file names and paths (put, gdx, ref, $include, etc.)
Definition: gamsoptions.h:260
void setSys11(const GAMSOptions::ESys11::ESys11Enum value)
Set Dynamic resorting if indices in assignment/data statements are not in natural order.
EStepSumEnum
Summary of computing resources used by job steps.
Definition: gamsoptions.h:566
void setPrefixLoadPath(const GAMSOptions::EPrefixLoadPath::EPrefixLoadPathEnum value)
Set Prepend GAMS system directory to library load path.
static std::string eFilteredCode(GAMSOptions::EFiltered::EFilteredEnum type)
Get Switch default for "$on/offFiltered" as code.
static EgdxUels::EgdxUelsEnum egdxUelsFromCode(const std::string &str)
Get Unload labels or UELs to GDX either squeezed or full from std::string
void setAction(const GAMSOptions::EAction::EActionEnum value)
Set GAMS processing request.
EgdxConvertEnum
Version of GDX files generated (for backward compatibility)
Definition: gamsoptions.h:316
void removeInputDir(const int index)
Remove an inputdir at position index of the inputdir list.
void setAppendOut(const GAMSOptions::EAppendOut::EAppendOutEnum value)
Set Output file append option.
int limCol()
Get Maximum number of columns listed in one variable block.
EgdxCompressEnum
Compression of generated GDX file.
Definition: gamsoptions.h:306
void setCErr(const int value)
Set Compile time error limit.
Placing of compilation error messages.
Definition: gamsoptions.h:218
std::string fileStem()
Get Sets the file stem for output files which use the input file name as stem by default.
int pageSize()
Get Output file page size (=0 no paging)
GAMSOptions::ESuffixAlgebraVars::ESuffixAlgebraVarsEnum suffixAlgebraVars()
Get Switch default for "$on/offSuffixAlgebraVars".
GAMSOptions::ECheckErrorLevel::ECheckErrorLevelEnum checkErrorLevel()
Get Check errorLevel automatically after executing external program.
void setUser2(const std::string &value)
Set User string N.
GAMSOptions::ESysOut::ESysOutEnum sysOut()
Get Solver Status file reporting option.
void setLstTitleLeftAligned(const GAMSOptions::ELstTitleLeftAligned::ELstTitleLeftAlignedEnum value)
Set Write title of LST file all left aligned.
void setIterLim(const int value)
Set Iteration limit of solver.
void setTabIn(const int value)
Set Tab spacing.
void setErrorLog(const int value)
Set Max error message lines written to the log for each error.
void setForceOptFile(const int value)
Set Overwrites other option file section mechanism.
void setForLim(const int value)
Set GAMS looping limit.
std::string RMIP()
Get default RMIP solver.
double resLim()
Get Wall-clock time limit for solver.
int inputDirSize()
Get the size of the inputdir list.
Error if assignment to singleton set has multiple elements.
Definition: gamsoptions.h:573
void setReference(const std::string &value)
Set Symbol reference file.
void setExecMode(const GAMSOptions::EExecMode::EExecModeEnum value)
Set Limits on external programs that are allowed to be executed.
void setJobTrace(const std::string &value)
Set Job trace string to be written to the trace file at the end of a GAMS job.
Show the memory usage reported by the Operating System instead of the internal counting.
Definition: gamsoptions.h:525
GAMSOptions::ELogLine::ELogLineEnum logLine()
Get Amount of line tracing to the log file.
void setTraceLevel(const int value)
Set Modelstat/Solvestat threshold used in conjunction with action=GT.
void setSuffixAlgebraVars(const GAMSOptions::ESuffixAlgebraVars::ESuffixAlgebraVarsEnum value)
Set Switch default for "$on/offSuffixAlgebraVars".
void setPageWidth(const int value)
Set Output file page width.
GAMSOptions::EZeroResRep::EZeroResRepEnum zeroResRep()
Get Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
GAMSOptions::EDigit::EDigitEnum digit()
Get Switch default for "$on/offDigit".
GAMSOptions::EOn115::EOn115Enum on115()
Get Generate errors for unknown unique element in an equation.
void setDomLim(const int value)
Set Domain violation limit solver default.
EInteractiveSolverEnum
Allow solver to interact via command line input.
Definition: gamsoptions.h:357
double optCA()
Get Absolute Optimality criterion solver default.
GAMSOptions::EDumpOpt::EDumpOptEnum dumpOpt()
Get Writes preprocessed input to the file input.dmp.
Switch default for "$on/offEmpty".
Definition: gamsoptions.h:208
void setWarnings(const int value)
Set Number of warnings permitted before a run terminates.
void setInlineCom(const std::string &value)
Set Switch default for "$on/offInline" and "$inlineCom".
void setProfile(const int value)
Set Execution profiling.
int profile()
Get Execution profiling.
GAMSOptions::EInteractiveSolver::EInteractiveSolverEnum interactiveSolver()
Get Allow solver to interact via command line input.
EDumpOptEnum
Writes preprocessed input to the file input.dmp.
Definition: gamsoptions.h:171
EShowOSMemoryEnum
Show the memory usage reported by the Operating System instead of the internal counting.
Definition: gamsoptions.h:528
void setAsyncSolLst(const GAMSOptions::EAsyncSolLst::EAsyncSolLstEnum value)
Set Print solution listing when asynchronous solve (Grid or Threads) is used.
EFDOptEnum
Options for finite differences.
Definition: gamsoptions.h:245
void setLstCase(const int value)
Set Output case option for LST file.
EErrMsgEnum
Placing of compilation error messages.
Definition: gamsoptions.h:221
int errorLog()
Get Max error message lines written to the log for each error.
double workFactor()
Get Memory Estimate multiplier for some solvers.
GAMSOptions::EListing::EListingEnum listing()
Get Switch default for "$on/offListing".
std::string iDCGDXOutput()
Get GDX file name for data for implicit output.
static std::string eActionText(GAMSOptions::EAction::EActionEnum type)
Get GAMS processing request as text.
std::string CNS()
Get default CNS solver.
std::string decryptKey()
Get Key to decrypt a text file that was encrypted via $encrypt.
void setFDDelta(const double value)
Set Step size for finite differences.
double fDDelta()
Get Step size for finite differences.
std::string RMINLP()
Get default RMINLP solver.
void setInputDir(const std::string value, const int index)
Replace inputdir at the specified index of the inputdir list.
void setInteger3(const int value)
Set Integer communication cell N.
int cErr()
Get Compile time error limit.
void setLP(const std::string &value)
Set default LP solver.
static std::string eEmptyText(GAMSOptions::EEmpty::EEmptyEnum type)
Get Switch default for "$on/offEmpty" as text.
Allow implicit loading of symbols from embedded code or not.
Definition: gamsoptions.h:198
double workSpace()
Get Work space for some solvers in MB.
void setThreadsAsync(const int value)
Set Limit on number of threads to be used for asynchronous solves (solveLink=6)
void setDNLP(const std::string &value)
Set default DNLP solver.
std::string fErr()
Get Alternative error message file.
void setMaxProcDir(const int value)
Set Maximum number of 225* process directories.
void setSolveLink(const GAMSOptions::ESolveLink::ESolveLinkEnum value)
Set Solver link option.
static const char * gamsVersion()
Get GAMS version information.
void setPutPW(const int value)
Set Page width for put files.
static std::string eDigitCode(GAMSOptions::EDigit::EDigitEnum type)
Get Switch default for "$on/offDigit" as code.
void setTimer(const int value)
Set Instruction timer threshold in milli seconds.
GAMSOptions::ESuppress::ESuppressEnum suppress()
Get Compiler listing option.
void setIntVarUp(const GAMSOptions::EIntVarUp::EIntVarUpEnum value)
Set Set mode for default upper bounds on integer variables.
void setInteger2(const int value)
Set Integer communication cell N.
std::string dumpOptGDX()
Get Defines a GDX file name stem created when using DumpOpt.
void setThreads(const int value)
Set Number of threads to be used by a solver.
Version of GDX files generated (for backward compatibility)
Definition: gamsoptions.h:313
void setTrace(const std::string &value)
Set Trace file name.
Controls keeping or deletion of process directory and scratch files.
Definition: gamsoptions.h:376
void setIDCGDXInput(const std::string &value)
Set GDX file name with data for implicit input.
std::string getInputDir(const int index)
Get an inputdir at position index of the inputdir list.
void setMIP(const std::string &value)
Set default MIP solver.