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

This is the representation of a single record of a GAMSSymbol. Derived classes are GAMSEquationRecord, GAMSParameterRecord, GAMSSetRecord and GAMSVariableRecord. More...

Inheritance diagram for GAMS.GAMSSymbolRecord:
GAMS.GAMSEquationRecord GAMS.GAMSParameterRecord GAMS.GAMSSetRecord GAMS.GAMSVariableRecord

Public Member Functions

string Key (int index)
 Retrieve key of GAMSSymbolRecord on position index.
 
bool MoveNext ()
 Iterate to next GAMSSymbolRecord of GAMSSymbol.
 
bool MovePrevious ()
 Iterate to previous GAMSSymbolRecord of GAMSSymbol.
 
override bool Equals (object obj)
 Indicates whether another object is "equal to" this one. This is the case if they hold the internal reference is the same.
 
override int GetHashCode ()
 Calculates a Hash Code based on the Sympol Iteration Pointer (aka the internal reference).
 
bool Equals (GAMSSymbolRecord r)
 Indicates whether another GAMSSymbolRecord is "equal to" this one. This is the case if they hold the same internal reference.
 

Static Public Member Functions

static bool operator== (GAMSSymbolRecord lhs, GAMSSymbolRecord rhs)
 Indicate whether two GAMSSymbolRecords are equal to each other. This is the case if they hold the internal reference is the same.
 
static bool operator!= (GAMSSymbolRecord lhs, GAMSSymbolRecord rhs)
 Indicate whether two GAMSSymbolRecords are not equal to each other. This is the case if they hold different internal references.
 

Properties

string[] Keys [get]
 Retrieve keys of GAMSSymbolRecord.
 

Detailed Description

This is the representation of a single record of a GAMSSymbol. Derived classes are GAMSEquationRecord, GAMSParameterRecord, GAMSSetRecord and GAMSVariableRecord.

Member Function Documentation

◆ Equals() [1/2]

bool GAMS.GAMSSymbolRecord.Equals ( GAMSSymbolRecord  r)
inline

Indicates whether another GAMSSymbolRecord is "equal to" this one. This is the case if they hold the same internal reference.

Parameters
rThe reference GAMSSymbolRecord with which to compare
Returns
True if this GAMSSymbolRecord is the same as the r argument; False otherwise.

◆ Equals() [2/2]

override bool GAMS.GAMSSymbolRecord.Equals ( object  obj)
inline

Indicates whether another object is "equal to" this one. This is the case if they hold the internal reference is the same.

Parameters
objThe reference object with which to compare
Returns
True if this object is the same as the obj argument; False otherwise.

◆ GetHashCode()

override int GAMS.GAMSSymbolRecord.GetHashCode ( )
inline

Calculates a Hash Code based on the Sympol Iteration Pointer (aka the internal reference).

Returns
A Hash Code based on the Sympol IterationPointer (aka the internal reference)

◆ Key()

string GAMS.GAMSSymbolRecord.Key ( int  index)
inline

Retrieve key of GAMSSymbolRecord on position index.

Parameters
indexIndex position of key to be returned
Returns
Key at position index

◆ MoveNext()

bool GAMS.GAMSSymbolRecord.MoveNext ( )
inline

Iterate to next GAMSSymbolRecord of GAMSSymbol.

Returns
True if everything worked, false otherwise

◆ MovePrevious()

bool GAMS.GAMSSymbolRecord.MovePrevious ( )
inline

Iterate to previous GAMSSymbolRecord of GAMSSymbol.

Returns
True if everything worked, false otherwise

◆ operator!=()

static bool GAMS.GAMSSymbolRecord.operator!= ( GAMSSymbolRecord  lhs,
GAMSSymbolRecord  rhs 
)
inlinestatic

Indicate whether two GAMSSymbolRecords are not equal to each other. This is the case if they hold different internal references.

Parameters
lhsFirst GAMSSymbolRecord to be compared.
rhsSecond GAMSSymbolRecord to be compared.
Returns
True if both GAMSSymbolRecords are different; False otherwise.

◆ operator==()

static bool GAMS.GAMSSymbolRecord.operator== ( GAMSSymbolRecord  lhs,
GAMSSymbolRecord  rhs 
)
inlinestatic

Indicate whether two GAMSSymbolRecords are equal to each other. This is the case if they hold the internal reference is the same.

Parameters
lhsFirst GAMSSymbolRecord to be compared.
rhsSecond GAMSSymbolRecord to be compared.
Returns
True if both GAMSSymbolRecords are the same; False otherwise.

Property Documentation

◆ Keys

string [] GAMS.GAMSSymbolRecord.Keys
get

Retrieve keys of GAMSSymbolRecord.