Loading...
Searching...
No Matches
gamsmodifier.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 GAMSMODIFIER_H
27#define GAMSMODIFIER_H
28
29#include "gamslib_global.h"
30#include <memory>
31#include "gamsenum.h"
32
33namespace gams {
34
35class GAMSSymbol;
36class GAMSParameter;
37class GAMSVariable;
38class GAMSEquation;
39class GAMSModifierImpl;
40
47class LIBSPEC GAMSModifier
48{
49public:
51 GAMSModifier() {}
52
56 GAMSModifier(const GAMSParameter& gamsPar, GAMSEnum::SymbolUpdateType updType = GAMSEnum::SymbolUpdateType::Inherit);
57
63 GAMSModifier(const GAMSVariable& gamsVar, GAMSEnum::SymbolUpdateAction updAction, const GAMSParameter& dataSym
64 , GAMSEnum::SymbolUpdateType updType = GAMSEnum::SymbolUpdateType::Inherit);
65
71 GAMSModifier(const GAMSEquation& gamsEqu, GAMSEnum::SymbolUpdateAction updAction, const GAMSParameter& dataSym
72 , GAMSEnum::SymbolUpdateType updType = GAMSEnum::SymbolUpdateType::Inherit);
73
77 GAMSModifier& operator=(const GAMSModifier& other);
78
82 bool operator!=(const GAMSModifier& other) const;
83
87 bool operator==(const GAMSModifier& other) const;
88
91 bool isValid() const;
92
95 GAMSSymbol gamsSymbol();
96
99 GAMSEnum::SymbolUpdateAction updAction();
100
103 GAMSParameter dataSymbol();
104
107 GAMSEnum::SymbolUpdateType updType();
108
109 // TODO(jm) new getter in API
112 bool isParameter();
113
114 // TODO(jm) new getter in API
117 bool isVariable();
118
119 // TODO(jm) new getter in API
122 bool isEquation();
123
124private:
125 std::shared_ptr<GAMSModifierImpl> mImpl;
126};
127
128} // namespace gams
129
130#endif // GAMSMODIFIER_H
gams::GAMSEnum::SymbolUpdateType
SymbolUpdateType
Symbol update type.
Definition: gamsenum.h:208
gams::GAMSEnum::SymbolUpdateAction
SymbolUpdateAction
What field to update.
Definition: gamsenum.h:187
gams::GAMSModifier::operator=
GAMSModifier & operator=(const GAMSModifier &other)
gams::GAMSModifier::operator!=
bool operator!=(const GAMSModifier &other) const
gams::GAMSModifier::GAMSModifier
GAMSModifier(const GAMSVariable &gamsVar, GAMSEnum::SymbolUpdateAction updAction, const GAMSParameter &dataSym, GAMSEnum::SymbolUpdateType updType=GAMSEnum::SymbolUpdateType::Inherit)
gams::GAMSModifier::dataSymbol
GAMSParameter dataSymbol()
gams::GAMSModifier::updType
GAMSEnum::SymbolUpdateType updType()
gams::GAMSModifier::GAMSModifier
GAMSModifier(const GAMSEquation &gamsEqu, GAMSEnum::SymbolUpdateAction updAction, const GAMSParameter &dataSym, GAMSEnum::SymbolUpdateType updType=GAMSEnum::SymbolUpdateType::Inherit)
gams::GAMSModifier::GAMSModifier
GAMSModifier(const GAMSParameter &gamsPar, GAMSEnum::SymbolUpdateType updType=GAMSEnum::SymbolUpdateType::Inherit)
gams::GAMSModifier::operator==
bool operator==(const GAMSModifier &other) const
gams::GAMSModifier::GAMSModifier
GAMSModifier()
Default constructor.
Definition: gamsmodifier.h:51
gams::GAMSModifier::gamsSymbol
GAMSSymbol gamsSymbol()
gams::GAMSModifier::updAction
GAMSEnum::SymbolUpdateAction updAction()
gams::GAMSModifier::isValid
bool isValid() const
gams
Definition: gams.h:91