Loading...
Searching...
No Matches
gamsparameter.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>s
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 GAMSPARAMETER_H
27#define GAMSPARAMETER_H
28
29#include "gamssymbol.h"
30#include "gamsparameterrecord.h"
31
32namespace gams {
33
36class LIBSPEC GAMSParameter : public GAMSSymbol
37{
38public:
39 typedef GAMSParameterRecord RecordType;
40
42 GAMSParameter() {}
43
46 GAMSParameter(const GAMSSymbol& other);
47
49 ~GAMSParameter();
50
53 GAMSSymbolIter<GAMSParameter> begin();
54
57 GAMSSymbolIter<GAMSParameter> end();
58
62 GAMSParameter& operator=(const GAMSParameter& other);
63
67 GAMSParameterRecord firstRecord(const std::vector<std::string>& slice);
68
71 GAMSParameterRecord firstRecord();
72
76 GAMSParameterRecord firstRecord(const std::string& key1);
77
82 GAMSParameterRecord firstRecord(const std::string& key1, const std::string& key2);
83
89 GAMSParameterRecord firstRecord(const std::string& key1, const std::string& key2, const std::string& key3);
90
94 GAMSParameterRecord lastRecord(const std::vector<std::string>& slice);
95
98 GAMSParameterRecord lastRecord();
99
103 GAMSParameterRecord lastRecord(const std::string& key1);
104
109 GAMSParameterRecord lastRecord(const std::string& key1, const std::string& key2);
110
116 GAMSParameterRecord lastRecord(const std::string& key1, const std::string& key2, const std::string& key3);
117
121 GAMSParameterRecord findRecord(const std::vector<std::string>& keys);
122
125 GAMSParameterRecord findRecord();
126
130 GAMSParameterRecord findRecord(const std::string& key1);
131
136 GAMSParameterRecord findRecord(const std::string& key1, const std::string& key2);
137
143 GAMSParameterRecord findRecord(const std::string& key1, const std::string& key2, const std::string& key3);
144
148 GAMSParameterRecord mergeRecord(const std::vector<std::string>& keys);
149
152 GAMSParameterRecord mergeRecord();
153
157 GAMSParameterRecord mergeRecord(const std::string& key1);
158
163 GAMSParameterRecord mergeRecord(const std::string& key1, const std::string& key2);
164
170 GAMSParameterRecord mergeRecord(const std::string& key1, const std::string& key2, const std::string& key3);
171
175 GAMSParameterRecord addRecord(const std::vector<std::string>& keys);
176
179 GAMSParameterRecord addRecord();
180
184 GAMSParameterRecord addRecord(const std::string& key1);
185
190 GAMSParameterRecord addRecord(const std::string& key1, const std::string& key2);
191
197 GAMSParameterRecord addRecord(const std::string& key1, const std::string& key2, const std::string& key3);
198
199private:
200 friend class GAMSDatabaseImpl;
201 friend class GAMSSymbolIter<GAMSParameter>;
202 GAMSParameter(GAMSDatabase& database, void *symPtr, int dim, std::string name, std::string text);
203 GAMSParameter(GAMSDatabase& database, const std::string& name, const int dim, const std::string& text);
204 GAMSParameter(GAMSDatabase& database, const std::string& name, const std::string& text, const std::vector<GAMSDomain>& domains);
205
206};
207
208
209} // namespace gams
210
211#endif // GAMSPARAMETER_H
gams::GAMSParameterRecord
This is the representation of a single record of a GAMSParameter.
Definition: gamsparameterrecord.h:37
gams::GAMSParameter::lastRecord
GAMSParameterRecord lastRecord()
gams::GAMSParameter::lastRecord
GAMSParameterRecord lastRecord(const std::string &key1, const std::string &key2)
gams::GAMSParameter::addRecord
GAMSParameterRecord addRecord(const std::string &key1)
gams::GAMSParameter::findRecord
GAMSParameterRecord findRecord(const std::vector< std::string > &keys)
gams::GAMSParameter::lastRecord
GAMSParameterRecord lastRecord(const std::string &key1, const std::string &key2, const std::string &key3)
gams::GAMSParameter::mergeRecord
GAMSParameterRecord mergeRecord(const std::string &key1, const std::string &key2)
gams::GAMSParameter::firstRecord
GAMSParameterRecord firstRecord(const std::string &key1, const std::string &key2, const std::string &key3)
gams::GAMSParameter::mergeRecord
GAMSParameterRecord mergeRecord(const std::string &key1, const std::string &key2, const std::string &key3)
gams::GAMSParameter::firstRecord
GAMSParameterRecord firstRecord(const std::vector< std::string > &slice)
gams::GAMSParameter::findRecord
GAMSParameterRecord findRecord(const std::string &key1)
gams::GAMSParameter::addRecord
GAMSParameterRecord addRecord(const std::vector< std::string > &keys)
gams::GAMSParameter::addRecord
GAMSParameterRecord addRecord()
gams::GAMSParameter::~GAMSParameter
~GAMSParameter()
Destructor.
gams::GAMSParameter::mergeRecord
GAMSParameterRecord mergeRecord(const std::string &key1)
gams::GAMSParameter::begin
GAMSSymbolIter< GAMSParameter > begin()
gams::GAMSParameter::GAMSParameter
GAMSParameter(const GAMSSymbol &other)
gams::GAMSParameter::findRecord
GAMSParameterRecord findRecord(const std::string &key1, const std::string &key2, const std::string &key3)
gams::GAMSParameter::end
GAMSSymbolIter< GAMSParameter > end()
gams::GAMSParameter::firstRecord
GAMSParameterRecord firstRecord()
gams::GAMSParameter::firstRecord
GAMSParameterRecord firstRecord(const std::string &key1, const std::string &key2)
gams::GAMSParameter::firstRecord
GAMSParameterRecord firstRecord(const std::string &key1)
gams::GAMSParameter::mergeRecord
GAMSParameterRecord mergeRecord()
gams::GAMSParameter::lastRecord
GAMSParameterRecord lastRecord(const std::vector< std::string > &slice)
gams::GAMSParameter::findRecord
GAMSParameterRecord findRecord(const std::string &key1, const std::string &key2)
gams::GAMSParameter::mergeRecord
GAMSParameterRecord mergeRecord(const std::vector< std::string > &keys)
gams::GAMSParameter::lastRecord
GAMSParameterRecord lastRecord(const std::string &key1)
gams::GAMSParameter::GAMSParameter
GAMSParameter()
Standard constructor.
Definition: gamsparameter.h:42
gams::GAMSParameter::operator=
GAMSParameter & operator=(const GAMSParameter &other)
gams::GAMSParameter::addRecord
GAMSParameterRecord addRecord(const std::string &key1, const std::string &key2, const std::string &key3)
gams::GAMSParameter::addRecord
GAMSParameterRecord addRecord(const std::string &key1, const std::string &key2)
gams::GAMSParameter::findRecord
GAMSParameterRecord findRecord()
gams
Definition: gams.h:91