gamsworkspaceinfo.h
1/*
2  * GAMS - General Algebraic Modeling System C++ API
3  *
4  * Copyright (c) 2017-2022 GAMS Software GmbH <support@gams.com>
5  * Copyright (c) 2017-2022 GAMS Development Corp. <support@gams.com>
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy
8  * of this software and associated documentation files (the "Software"), to deal
9  * in the Software without restriction, including without limitation the rights
10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11  * copies of the Software, and to permit persons to whom the Software is
12  * furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23  * SOFTWARE.
24  */
25 
26 #ifndef GAMSWORKSPACEINFO_H
27 #define GAMSWORKSPACEINFO_H
28 
29 #include <string>
30 #include "gamsenum.h"
31 
32 namespace gams {
33 
34 class GAMSWorkspaceInfoImpl;
35 
37 class LIBSPEC GAMSWorkspaceInfo
38 {
39 public:
45  GAMSWorkspaceInfo(std::string workingDirectory = "", std::string systemDirectory = ""
46  , GAMSEnum::DebugLevel debug = GAMSEnum::DebugLevel::Off);
47 
51 
55  bool operator==(const GAMSWorkspaceInfo& other) const;
56 
60  bool operator!=(const GAMSWorkspaceInfo& other) const;
61 
63  std::string workingDirectory() const;
64 
67  void setWorkingDirectory(std::string workingDir);
68 
70  std::string systemDirectory() const;
71 
74  void setSystemDirectory(std::string systemDir);
75 
78 
82 
83 private:
84  std::shared_ptr<GAMSWorkspaceInfoImpl> mImpl;
85 };
86 
87 } // namespace gams
88 
89 #endif // GAMSWORKSPACEINFO_H
void setSystemDirectory(std::string systemDir)
bool operator!=(const GAMSWorkspaceInfo &other) const
bool operator==(const GAMSWorkspaceInfo &other) const
void setDebug(GAMSEnum::DebugLevel debug)
GAMSEnum::DebugLevel debug() const
Get GAMS debug level.
Definition: gams.h:91
std::string workingDirectory() const
Get GAMS working directory, i.e. the anchor for all file-based operations.
The GAMSWorkspaceInfo can be used to input parameters for the GAMSWorkspace constructor.
GAMSWorkspaceInfo(std::string workingDirectory="", std::string systemDirectory="", GAMSEnum::DebugLevel debug=GAMSEnum::DebugLevel::Off)
void setWorkingDirectory(std::string workingDir)
DebugLevel
GAMS Debug Level.
Definition: gamsenum.h:198
GAMSWorkspaceInfo(GAMSEnum::DebugLevel debug)
std::string systemDirectory() const
Get GAMS system directory, i.e. installation directory of the GAMS distribution.