gamssymboliter.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 GAMSSYMBOLITER_H
27 #define GAMSSYMBOLITER_H
28 
29 #include "gamslib_global.h"
30 
31 namespace gams {
32 
33 template <class T>
34 
37 class LIBSPEC GAMSSymbolIter // TODO(RG): what about this LIBSPEC?
38 {
39 public:
40 
44  GAMSSymbolIter(T& symbol, int pos);
45 
48 
52  bool operator==(const GAMSSymbolIter<T>& other) const;
53 
57  bool operator!=(const GAMSSymbolIter<T>& other) const;
58 
61  typename T::RecordType& operator*();
62 
66 
67 private:
68  T& mSymbol;
69  typename T::RecordType* mSymRecord;
70  int mPos;
71  void* mSymIterPtr;
72 };
73 
74 } // namespace gams
75 
76 #endif // GAMSSYMBOLITER_H
~GAMSSymbolIter()
Destructor.
Definition: gams.h:91
bool operator==(const GAMSSymbolIter< T > &other) const
bool operator!=(const GAMSSymbolIter< T > &other) const
GAMSSymbolIter(T &symbol, int pos)
T::RecordType & operator*()
GAMSSymbolIter< T > & operator++()