gamscheckpoint.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 GAMSCHECKPOINT_H
27 #define GAMSCHECKPOINT_H
28 
29 #include "gamslib_global.h"
30 #include "gamsenum.h"
31 #include <string>
32 #include <memory>
33 
34 
35 namespace gams {
36 
37 class GAMSModelInstance;
38 class GAMSCheckpointImpl;
39 class GAMSWorkspace;
40 
47 class LIBSPEC GAMSCheckpoint
48 {
49 public:
52 
56 
60  GAMSCheckpoint(const GAMSWorkspace& ws, const std::string& checkpointName = "");
61 
66 
70  bool operator!=(const GAMSCheckpoint& other) const;
71 
75  bool operator==(const GAMSCheckpoint& other) const;
76 
80  GAMSModelInstance addModelInstance(const std::string& modelInstanceName = "");
81 
84  std::string name();
85 
89 
92  gams::LogId logID();
93 
96  bool isValid() const;
97 
100  std::string fileName() const;
101 
102 private:
103  std::shared_ptr<GAMSCheckpointImpl> mImpl;
104 };
105 
106 } // namespace gams
107 
108 #endif // GAMSCHECKPOINT_H
GAMSCheckpoint(const GAMSCheckpoint &other)
GAMSCheckpoint & operator=(const GAMSCheckpoint &other)
GAMSCheckpoint(const GAMSWorkspace &ws, const std::string &checkpointName="")
bool operator!=(const GAMSCheckpoint &other) const
Definition: gams.h:91
GAMSCheckpoint()
Standard constructor.
GAMSModelInstance addModelInstance(const std::string &modelInstanceName="")
std::string name()
GAMSWorkspace workspace()
gams::LogId logID()
bool operator==(const GAMSCheckpoint &other) const
std::string fileName() const
bool isValid() const