Loading...
Searching...
No Matches
gamssymbolrecord.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 GAMSSYMBOLRECORD_H
27#define GAMSSYMBOLRECORD_H
28
29#include <string>
30#include <vector>
31#include "gamsenum.h"
32#include "gamssymboliter.h"
33
34namespace gams {
35
36class GAMSSet;
37class GAMSParameter;
38class GAMSVariable;
39class GAMSEquation;
40class GAMSSymbolRecordImpl;
41class GAMSSymbol;
42
45class LIBSPEC GAMSSymbolRecord
46{
47public:
50 GAMSSymbolRecord();
51
54 GAMSSymbolRecord(const GAMSSymbolRecord& record);
55
57 virtual ~GAMSSymbolRecord();
58
62 GAMSSymbolRecord& operator =(const GAMSSymbolRecord& other);
63
67 bool operator!=(const GAMSSymbolRecord& other) const;
68
72 bool operator==(const GAMSSymbolRecord& other) const;
73
76 bool isValid() const;
77
80 bool moveNext();
81
84 bool movePrevious();
85
87 std::vector<std::string> keys();
88
92 std::string key(int index);
93
97 std::string operator[](int i);
98
101 LogId logID();
102
104 GAMSEnum::SymbolType type() const;
105
106private:
107 friend class GAMSSymbolImpl;
108 friend class GAMSSetRecord;
109 friend class GAMSParameterRecord;
110 friend class GAMSVariableRecord;
111 friend class GAMSEquationRecord;
112 friend class GAMSSymbolIter<GAMSSymbol>;
113 friend class GAMSSymbolIter<GAMSSet>;
114 friend class GAMSSymbolIter<GAMSParameter>;
115 friend class GAMSSymbolIter<GAMSVariable>;
116 friend class GAMSSymbolIter<GAMSEquation>;
117 GAMSSymbolRecord(GAMSSymbol symbol, void* symIterPtr);
118private:
119 std::shared_ptr<GAMSSymbolRecordImpl> mImpl;
120
121}; // class GAMSSymbolRecord
122
123} // namespace gams
124#endif // GAMSSYMBOLRECORD_H
gams::GAMSEnum::SymbolType
SymbolType
This enum defines the type of a symbol (The type Alias is not supported and shows as Set).
Definition: gamsenum.h:44
gams::GAMSEquationRecord
This class represents a single record of a GAMSEquation.
Definition: gamsequationrecord.h:37
gams::GAMSParameterRecord
This is the representation of a single record of a GAMSParameter.
Definition: gamsparameterrecord.h:37
gams::GAMSSetRecord
This is the representation of a single record of a GAMSSet.
Definition: gamssetrecord.h:37
gams::GAMSSymbolRecord::~GAMSSymbolRecord
virtual ~GAMSSymbolRecord()
Destructor.
gams::GAMSSymbolRecord::operator==
bool operator==(const GAMSSymbolRecord &other) const
gams::GAMSSymbolRecord::GAMSSymbolRecord
GAMSSymbolRecord(const GAMSSymbolRecord &record)
gams::GAMSSymbolRecord::operator[]
std::string operator[](int i)
gams::GAMSSymbolRecord::key
std::string key(int index)
gams::GAMSSymbolRecord::keys
std::vector< std::string > keys()
Retrieve keys of GAMSSymbolRecord.
gams::GAMSSymbolRecord::operator!=
bool operator!=(const GAMSSymbolRecord &other) const
gams::GAMSSymbolRecord::type
GAMSEnum::SymbolType type() const
Get the GAMSSymbol type.
gams::GAMSVariableRecord
This is the representation of a single record of a GAMSVariable.
Definition: gamsvariablerecord.h:37
gams
Definition: gams.h:91