gams::GAMSSymbolIter< T > Class Template Reference

#include <gamssymboliter.h>

Public Member Functions

 GAMSSymbolIter (T &symbol, int pos)
 
 ~GAMSSymbolIter ()
 Destructor. More...
 
bool operator== (const GAMSSymbolIter< T > &other) const
 
bool operator!= (const GAMSSymbolIter< T > &other) const
 
T::RecordType & operator* ()
 
GAMSSymbolIter< T > & operator++ ()
 

Detailed Description

template<class T>
class gams::GAMSSymbolIter< T >

Iterates through the records of a specific GAMSSymbol.

Remarks
This class can be used with all GAMSSymbol types.

Definition at line 37 of file gamssymboliter.h.

Constructor & Destructor Documentation

◆ GAMSSymbolIter()

template<class T>
gams::GAMSSymbolIter< T >::GAMSSymbolIter ( T &  symbol,
int  pos 
)

Constructs a GAMSSymbolIter.

Parameters
symbolIterator related GAMSSymbol.
posPosition the iterator is related to.

◆ ~GAMSSymbolIter()

template<class T>
gams::GAMSSymbolIter< T >::~GAMSSymbolIter ( )

Destructor.

Member Function Documentation

◆ operator!=()

template<class T>
bool gams::GAMSSymbolIter< T >::operator!= ( const GAMSSymbolIter< T > &  other) const

Compares two GAMSSymbolIter<T>.

Parameters
otherAnother GAMSSymbolIter<T> to compare to.
Returns
Returns true if the two GAMSSymbolIter<T> are different; otherwise false.

◆ operator*()

template<class T>
T::RecordType& gams::GAMSSymbolIter< T >::operator* ( )

Dereferences the iterator.

Returns
Returns the actual object.

◆ operator++()

template<class T>
GAMSSymbolIter<T>& gams::GAMSSymbolIter< T >::operator++ ( )

Increments the iterator.

Returns
Returns the incremented iterator.

◆ operator==()

template<class T>
bool gams::GAMSSymbolIter< T >::operator== ( const GAMSSymbolIter< T > &  other) const

Compares two GAMSSymbolIter<T> objects.

Parameters
otherAnother GAMSSymbolIter<T> to compare to.
Returns
Returns true if the two GAMSSymbolIter<T> are equal; otherwise false.