Loading...
Searching...
No Matches
gams::GAMSSymbolRecord Class Reference
#include <gamssymbolrecord.h>
Inheritance diagram for gams::GAMSSymbolRecord:
Public Member Functions | |
| GAMSSymbolRecord () | |
| GAMSSymbolRecord (const GAMSSymbolRecord &record) | |
| virtual | ~GAMSSymbolRecord () |
| Destructor. | |
| GAMSSymbolRecord & | operator= (const GAMSSymbolRecord &other) |
| bool | operator!= (const GAMSSymbolRecord &other) const |
| bool | operator== (const GAMSSymbolRecord &other) const |
| bool | isValid () const |
| bool | moveNext () |
| bool | movePrevious () |
| std::vector< std::string > | keys () |
| Retrieve keys of GAMSSymbolRecord. | |
| std::string | key (int index) |
| std::string | operator[] (int i) |
| LogId | logID () |
| GAMSEnum::SymbolType | type () const |
| Get the GAMSSymbol type. | |
Detailed Description
This is the representation of a single record of a GAMSSymbol.
- Remarks
- Derived classes are GAMSEquationRecord, GAMSParameterRecord, GAMSSetRecord and GAMSVariableRecord.
Definition at line 45 of file gamssymbolrecord.h.
Constructor & Destructor Documentation
◆ GAMSSymbolRecord() [1/2]
| gams::GAMSSymbolRecord::GAMSSymbolRecord | ( | ) |
The default constructor allows to create an uninitialized GAMSSymbolRecord to be used later in the code. The method isValid() shows if the instance is initialized.
◆ GAMSSymbolRecord() [2/2]
| gams::GAMSSymbolRecord::GAMSSymbolRecord | ( | const GAMSSymbolRecord & | record | ) |
Copy constructor
- Parameters
-
record GAMSSymbolRecord used to initialize the new GAMSSymbolRecord.
◆ ~GAMSSymbolRecord()
|
virtual |
Destructor.
Member Function Documentation
◆ isValid()
| bool gams::GAMSSymbolRecord::isValid | ( | ) | const |
Checks if a GAMSSymbolRecord is valid.
- Returns
- Returns
trueif the GAMSSymbolRecord is valid; otherwisefalse.
◆ key()
| std::string gams::GAMSSymbolRecord::key | ( | int | index | ) |
Retrieve key of GAMSSymbolRecord on position index.
- Parameters
-
index Index position of key to be returned.
- Returns
- Returns the key at position index.
◆ keys()
| std::vector< std::string > gams::GAMSSymbolRecord::keys | ( | ) |
Retrieve keys of GAMSSymbolRecord.
◆ logID()
| LogId gams::GAMSSymbolRecord::logID | ( | ) |
Get the GAMS log ID.
- Returns
- Returns the GAMS log ID.
◆ moveNext()
| bool gams::GAMSSymbolRecord::moveNext | ( | ) |
Iterate to next GAMSSymbolRecord of GAMSSymbol.
- Returns
- Returns
trueif everything worked; otherwisefalse.
◆ movePrevious()
| bool gams::GAMSSymbolRecord::movePrevious | ( | ) |
Iterate to previous GAMSSymbolRecord of GAMSSymbol
- Returns
- Returns
trueif everything worked; otherwisefalse.
◆ operator!=()
| bool gams::GAMSSymbolRecord::operator!= | ( | const GAMSSymbolRecord & | other | ) | const |
Compares two GAMSSymbolRecord objects.
- Parameters
-
other Another GAMSSymbolRecord to compare to.
- Returns
- Returns
trueif the two GAMSSymbolRecord are different; otherwisefalse.
◆ operator=()
| GAMSSymbolRecord & gams::GAMSSymbolRecord::operator= | ( | const GAMSSymbolRecord & | other | ) |
Assigns a GAMSSymbolRecord.
- Parameters
-
other Another GAMSSymbolRecord used as data source.
- Returns
- Returns the assigned GAMSSymbolRecord (*this).
◆ operator==()
| bool gams::GAMSSymbolRecord::operator== | ( | const GAMSSymbolRecord & | other | ) | const |
Compares two GAMSSymbolRecord objects.
- Parameters
-
other Another GAMSSymbolRecord to compare to.
- Returns
- Returns
trueif the two GAMSSymbolRecord are equal; otherwisefalse.
◆ operator[]()
| std::string gams::GAMSSymbolRecord::operator[] | ( | int | i | ) |
Access specified GAMSSymbolRecord.
- Parameters
-
i Index of the element to return.
- Returns
- Returns the requested element.
◆ type()
| GAMSEnum::SymbolType gams::GAMSSymbolRecord::type | ( | ) | const |
Get the GAMSSymbol type.