Loading...
Searching...
No Matches
gams::GAMSWorkspaceInfo Class Reference
The GAMSWorkspaceInfo can be used to input parameters for the GAMSWorkspace constructor. More...
#include <gamsworkspaceinfo.h>
Public Member Functions | |
| GAMSWorkspaceInfo (const std::string &workingDirectory="", const std::string &systemDirectory="", GAMSEnum::DebugLevel debug=GAMSEnum::DebugLevel::KeepFilesOnError) | |
| GAMSWorkspaceInfo (GAMSEnum::DebugLevel debug) | |
| bool | operator== (const GAMSWorkspaceInfo &other) const |
| bool | operator!= (const GAMSWorkspaceInfo &other) const |
| std::string | workingDirectory () const |
| Get GAMS working directory, i.e. the anchor for all file-based operations. | |
| void | setWorkingDirectory (const std::string &workingDir) |
| std::string | systemDirectory () const |
| Get GAMS system directory, i.e. installation directory of the GAMS distribution. | |
| void | setSystemDirectory (const std::string &systemDir) |
| GAMSEnum::DebugLevel | debug () const |
| Get GAMS debug level. | |
| void | setDebug (GAMSEnum::DebugLevel debug) |
Detailed Description
The GAMSWorkspaceInfo can be used to input parameters for the GAMSWorkspace constructor.
Definition at line 37 of file gamsworkspaceinfo.h.
Constructor & Destructor Documentation
◆ GAMSWorkspaceInfo() [1/2]
| gams::GAMSWorkspaceInfo::GAMSWorkspaceInfo | ( | const std::string & | workingDirectory = "", |
| const std::string & | systemDirectory = "", | ||
| GAMSEnum::DebugLevel | debug = GAMSEnum::DebugLevel::KeepFilesOnError ) |
Constructor
- Parameters
-
workingDirectory GAMS working directory, anchor for all file-based operations (determined automatically if omitted, in user's temporary folder) systemDirectory GAMS system directory (determined automatically if omitted) debug GAMS Debug Level.
◆ GAMSWorkspaceInfo() [2/2]
| gams::GAMSWorkspaceInfo::GAMSWorkspaceInfo | ( | GAMSEnum::DebugLevel | debug | ) |
Constructor.
- Parameters
-
debug GAMS Debug Level.
Member Function Documentation
◆ debug()
| GAMSEnum::DebugLevel gams::GAMSWorkspaceInfo::debug | ( | ) | const |
Get GAMS debug level.
◆ operator!=()
| bool gams::GAMSWorkspaceInfo::operator!= | ( | const GAMSWorkspaceInfo & | other | ) | const |
Compares two GAMSWorkspaceInfo objects.
- Parameters
-
other Another GAMSWorkspaceInfo to compare to.
- Returns
- Returns
trueif the two GAMSWorkspaceInfo are different; otherwisefalse.
◆ operator==()
| bool gams::GAMSWorkspaceInfo::operator== | ( | const GAMSWorkspaceInfo & | other | ) | const |
Compares two GAMSWorkspaceInfo objects.
- Parameters
-
other Another GAMSWorkspaceInfo to compare to.
- Returns
- Returns
trueif the two GAMSWorkspaceInfo are equal; otherwisefalse.
◆ setDebug()
| void gams::GAMSWorkspaceInfo::setDebug | ( | GAMSEnum::DebugLevel | debug | ) |
Set GAMS debug level.
- Parameters
-
debug GAMS debug level.
◆ setSystemDirectory()
| void gams::GAMSWorkspaceInfo::setSystemDirectory | ( | const std::string & | systemDir | ) |
Set GAMS system directory, i.e. installation directory of the GAMS distribution.
- Parameters
-
systemDir GAMS system directory.
◆ setWorkingDirectory()
| void gams::GAMSWorkspaceInfo::setWorkingDirectory | ( | const std::string & | workingDir | ) |
Set GAMS working directory, i.e. the anchor for all file-based operations.
- Parameters
-
workingDir GAMS working directory.
◆ systemDirectory()
| std::string gams::GAMSWorkspaceInfo::systemDirectory | ( | ) | const |
Get GAMS system directory, i.e. installation directory of the GAMS distribution.
◆ workingDirectory()
| std::string gams::GAMSWorkspaceInfo::workingDirectory | ( | ) | const |
Get GAMS working directory, i.e. the anchor for all file-based operations.