This is the representation of a single record of a GAMSVariable. More...
#include <gamsvariablerecord.h>
Public Member Functions | |
GAMSVariableRecord () | |
GAMSVariableRecord (const GAMSSymbolRecord &record) | |
GAMSVariableRecord & | operator= (const GAMSVariableRecord &other) |
double | level () |
void | setLevel (const double val) |
double | marginal () |
void | setMarginal (const double val) |
double | upper () |
void | setUpper (const double val) |
double | lower () |
void | setLower (const double val) |
double | scale () |
void | setScale (const double val) |
Public Member Functions inherited from gams::GAMSSymbolRecord | |
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 GAMSVariable.
Definition at line 36 of file gamsvariablerecord.h.
Constructor & Destructor Documentation
◆ GAMSVariableRecord() [1/2]
gams::GAMSVariableRecord::GAMSVariableRecord | ( | ) |
The default constructor allows to create an uninitialized GAMSVariableRecord to be used later in the code. The method isValid() shows if the instance is initialized.
◆ GAMSVariableRecord() [2/2]
gams::GAMSVariableRecord::GAMSVariableRecord | ( | const GAMSSymbolRecord & | record | ) |
Copy constructor
- Parameters
-
record Another GAMSSymbolRecord used as data source.
Member Function Documentation
◆ level()
double gams::GAMSVariableRecord::level | ( | ) |
Retrieve the level of this GAMSVariableRecord.
- Returns
- Returns the level.
◆ lower()
double gams::GAMSVariableRecord::lower | ( | ) |
Retrieve the lower bound of this GAMSVariableRecord.
- Returns
- Returns the lower bound.
◆ marginal()
double gams::GAMSVariableRecord::marginal | ( | ) |
Retrieve the marginal of this GAMSVariableRecord.
- Returns
- Returns the marginal.
◆ operator=()
GAMSVariableRecord & gams::GAMSVariableRecord::operator= | ( | const GAMSVariableRecord & | other | ) |
Assigns a GAMSVariableRecord.
- Parameters
-
other Another GAMSVariableRecord used as data source.
- Returns
- Returns the assigned GAMSVariableRecord (*this).
◆ scale()
double gams::GAMSVariableRecord::scale | ( | ) |
Retrieve the scale factor of this GAMSVariableRecord.
- Returns
- Returns the scale.
◆ setLevel()
void gams::GAMSVariableRecord::setLevel | ( | const double | val | ) |
Set the level of this GAMSVariableRecord.
- Parameters
-
val Level.
◆ setLower()
void gams::GAMSVariableRecord::setLower | ( | const double | val | ) |
Set the lower bound of this GAMSVariableRecord.
- Parameters
-
val Lower bound.
◆ setMarginal()
void gams::GAMSVariableRecord::setMarginal | ( | const double | val | ) |
Set the marginal of this GAMSVariableRecord.
- Parameters
-
val Marginal.
◆ setScale()
void gams::GAMSVariableRecord::setScale | ( | const double | val | ) |
Set the scale factor of this GAMSVariableRecord.
- Parameters
-
val scale factor.
◆ setUpper()
void gams::GAMSVariableRecord::setUpper | ( | const double | val | ) |
Set the upper bound of this GAMSVariableRecord.
- Parameters
-
val Upper bound.
◆ upper()
double gams::GAMSVariableRecord::upper | ( | ) |
Retrieve the upper bound of this GAMSVariableRecord.
- Returns
- Returns the upper bound.