Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
GAMS.GAMSSymbolEnumerator Class Reference

Enumerator for iterating through the records of a specific symbol. This class can be used with all GAMS symbol types. More...

Public Member Functions

 GAMSSymbolEnumerator (GAMSSymbol symbol)
 Constructor.
 
bool MoveNext ()
 Moves the enumerator to the next record.
 
void Reset ()
 Reset the enumerator to its initial state.
 

Properties

GAMSSymbolRecord Current [get]
 Retrieve the current symbol.
 

Detailed Description

Enumerator for iterating through the records of a specific symbol. This class can be used with all GAMS symbol types.

Constructor & Destructor Documentation

◆ GAMSSymbolEnumerator()

GAMS.GAMSSymbolEnumerator.GAMSSymbolEnumerator ( GAMSSymbol symbol)
inline

Constructor.

Parameters
symbolThe symbol that is bound to this Enumerator

Member Function Documentation

◆ MoveNext()

bool GAMS.GAMSSymbolEnumerator.MoveNext ( )
inline

Moves the enumerator to the next record.

Returns
True if the operation is possible, false otherwise.

◆ Reset()

void GAMS.GAMSSymbolEnumerator.Reset ( )
inline

Reset the enumerator to its initial state.

Property Documentation

◆ Current

GAMSSymbolRecord GAMS.GAMSSymbolEnumerator.Current
get

Retrieve the current symbol.

Returns
The current symbol record. This is an instance of a subclass of GAMSSymbolRecord, namely either GAMSVariableRecord, GAMSEquationRecord, GAMSVariableRecord or GAMSSetRecord.