Loading...
Searching...
No Matches
gamscheckpoint.h
1/*
2 * GAMS - General Algebraic Modeling System C++ API
3 *
4 * Copyright (c) 2017-2024 GAMS Software GmbH <support@gams.com>
5 * Copyright (c) 2017-2024 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 <string>
31#include <memory>
32
33
34namespace gams {
35
36class GAMSModelInstance;
37class GAMSCheckpointImpl;
38class GAMSWorkspace;
39
46class LIBSPEC GAMSCheckpoint
47{
48public:
50 GAMSCheckpoint();
51
54 GAMSCheckpoint(const GAMSCheckpoint &other);
55
59 GAMSCheckpoint(const GAMSWorkspace& ws, const std::string& checkpointName = "");
60
64 GAMSCheckpoint& operator=(const GAMSCheckpoint& other);
65
69 bool operator!=(const GAMSCheckpoint& other) const;
70
74 bool operator==(const GAMSCheckpoint& other) const;
75
79 GAMSModelInstance addModelInstance(const std::string& modelInstanceName = "");
80
83 std::string name();
84
87 GAMSWorkspace workspace();
88
91 gams::LogId logID();
92
95 bool isValid() const;
96
99 std::string fileName() const;
100
101private:
102 std::shared_ptr<GAMSCheckpointImpl> mImpl;
103};
104
105} // namespace gams
106
107#endif // GAMSCHECKPOINT_H
gams::GAMSCheckpoint::logID
gams::LogId logID()
gams::GAMSCheckpoint::addModelInstance
GAMSModelInstance addModelInstance(const std::string &modelInstanceName="")
gams::GAMSCheckpoint::operator==
bool operator==(const GAMSCheckpoint &other) const
gams::GAMSCheckpoint::operator=
GAMSCheckpoint & operator=(const GAMSCheckpoint &other)
gams::GAMSCheckpoint::workspace
GAMSWorkspace workspace()
gams::GAMSCheckpoint::name
std::string name()
gams::GAMSCheckpoint::GAMSCheckpoint
GAMSCheckpoint()
Standard constructor.
gams::GAMSCheckpoint::isValid
bool isValid() const
gams::GAMSCheckpoint::GAMSCheckpoint
GAMSCheckpoint(const GAMSCheckpoint &other)
gams::GAMSCheckpoint::GAMSCheckpoint
GAMSCheckpoint(const GAMSWorkspace &ws, const std::string &checkpointName="")
gams::GAMSCheckpoint::operator!=
bool operator!=(const GAMSCheckpoint &other) const
gams::GAMSCheckpoint::fileName
std::string fileName() const
gams
Definition: gams.h:91