gams::GAMSDatabaseIter Class Reference
#include <gamsdatabaseiter.h>
Public Member Functions | |
GAMSDatabaseIter (std::shared_ptr< GAMSDatabaseImpl > database, int pos=0) | |
bool | operator== (const GAMSDatabaseIter &other) |
bool | operator!= (const GAMSDatabaseIter &other) |
GAMSSymbol | operator* () |
GAMSDatabaseIter & | operator++ () |
Detailed Description
Iterates through all GAMSSymbol objects within a GAMSDatabase.
- Remarks
- This class can be used with all GAMSSymbol types.
Definition at line 38 of file gamsdatabaseiter.h.
Constructor & Destructor Documentation
◆ GAMSDatabaseIter()
gams::GAMSDatabaseIter::GAMSDatabaseIter | ( | std::shared_ptr< GAMSDatabaseImpl > | database, |
int | pos = 0 |
||
) |
Constructs a GAMSDatabaseIter.
- Parameters
-
database Iterator related GAMSDatabase. pos Position the iterator is related to.
Member Function Documentation
◆ operator!=()
bool gams::GAMSDatabaseIter::operator!= | ( | const GAMSDatabaseIter & | other | ) |
Compares two GAMSDatabaseIter<T>.
- Parameters
-
other Another GAMSDatabaseIter<T> to compare to.
- Returns
- Returns
true
if the two GAMSDatabaseIter<T> are different; otherwisefalse
.
◆ operator*()
GAMSSymbol gams::GAMSDatabaseIter::operator* | ( | ) |
Dereferences the iterator.
- Returns
- Returns the actual object.
◆ operator++()
GAMSDatabaseIter & gams::GAMSDatabaseIter::operator++ | ( | ) |
Increments the iterator.
- Returns
- Returns the incremented iterator.
◆ operator==()
bool gams::GAMSDatabaseIter::operator== | ( | const GAMSDatabaseIter & | other | ) |
Compares two GAMSDatabaseIter<T> objects.
- Parameters
-
other Another GAMSDatabaseIter<T> to compare to.
- Returns
- Returns
true
if the two GAMSDatabaseIter<T> are equal; otherwisefalse
.