#include <gamsparameter.h>
Public Member Functions | |
GAMSParameter () | |
Standard constructor. | |
GAMSParameter (const GAMSSymbol &other) | |
~GAMSParameter () | |
Destructor. | |
GAMSSymbolIter< GAMSParameter > | begin () |
GAMSSymbolIter< GAMSParameter > | end () |
GAMSParameter & | operator= (const GAMSParameter &other) |
GAMSParameterRecord | firstRecord (const std::vector< std::string > &slice) |
GAMSParameterRecord | firstRecord () |
GAMSParameterRecord | firstRecord (const std::string &key1) |
GAMSParameterRecord | firstRecord (const std::string &key1, const std::string &key2) |
GAMSParameterRecord | firstRecord (const std::string &key1, const std::string &key2, const std::string &key3) |
GAMSParameterRecord | lastRecord (const std::vector< std::string > &slice) |
GAMSParameterRecord | lastRecord () |
GAMSParameterRecord | lastRecord (const std::string &key1) |
GAMSParameterRecord | lastRecord (const std::string &key1, const std::string &key2) |
GAMSParameterRecord | lastRecord (const std::string &key1, const std::string &key2, const std::string &key3) |
GAMSParameterRecord | findRecord (const std::vector< std::string > &keys) |
GAMSParameterRecord | findRecord () |
GAMSParameterRecord | findRecord (const std::string &key1) |
GAMSParameterRecord | findRecord (const std::string &key1, const std::string &key2) |
GAMSParameterRecord | findRecord (const std::string &key1, const std::string &key2, const std::string &key3) |
GAMSParameterRecord | mergeRecord (const std::vector< std::string > &keys) |
GAMSParameterRecord | mergeRecord () |
GAMSParameterRecord | mergeRecord (const std::string &key1) |
GAMSParameterRecord | mergeRecord (const std::string &key1, const std::string &key2) |
GAMSParameterRecord | mergeRecord (const std::string &key1, const std::string &key2, const std::string &key3) |
GAMSParameterRecord | addRecord (const std::vector< std::string > &keys) |
GAMSParameterRecord | addRecord () |
GAMSParameterRecord | addRecord (const std::string &key1) |
GAMSParameterRecord | addRecord (const std::string &key1, const std::string &key2) |
GAMSParameterRecord | addRecord (const std::string &key1, const std::string &key2, const std::string &key3) |
Public Member Functions inherited from gams::GAMSSymbol | |
GAMSSymbol () | |
Standard constructor. | |
GAMSSymbol (const GAMSSymbol &symbol) | |
virtual | ~GAMSSymbol () |
Destructor. | |
GAMSSymbol | operator= (const GAMSSymbol &other) |
bool | operator!= (const GAMSSymbol &other) const |
bool | operator== (const GAMSSymbol &other) const |
bool | isValid () const |
GAMSSymbolIter< GAMSSymbol > | begin () |
GAMSSymbolIter< GAMSSymbol > | end () |
GAMSSymbolRecord | addRecord (const std::vector< std::string > &keys) |
GAMSSymbolRecord | addRecord () |
GAMSSymbolRecord | addRecord (const std::string &key1) |
GAMSSymbolRecord | addRecord (const std::string &key1, const std::string &key2) |
GAMSSymbolRecord | addRecord (const std::string &key1, const std::string &key2, const std::string &key3) |
void | deleteRecord (const std::vector< std::string > &keys) |
bool | clear () |
std::vector< GAMSDomain > | domains () |
bool | checkDomains () |
std::vector< GAMSSymbolDomainViolation > | getSymbolDVs (int maxViol=0) |
GAMSSymbolRecord | firstRecord (const std::vector< std::string > &slice) |
GAMSSymbolRecord | firstRecord () |
GAMSSymbolRecord | firstRecord (const std::string &key1) |
GAMSSymbolRecord | firstRecord (const std::string &key1, const std::string &key2) |
GAMSSymbolRecord | firstRecord (const std::string &key1, const std::string &key2, const std::string &key3) |
GAMSSymbolRecord | lastRecord (const std::vector< std::string > &slice) |
GAMSSymbolRecord | lastRecord () |
GAMSSymbolRecord | lastRecord (const std::string &key1) |
GAMSSymbolRecord | lastRecord (const std::string &key1, const std::string &key2) |
GAMSSymbolRecord | lastRecord (const std::string &key1, const std::string &key2, const std::string &key3) |
GAMSSymbolRecord | findRecord (const std::vector< std::string > &keys) |
GAMSSymbolRecord | findRecord () |
GAMSSymbolRecord | findRecord (const std::string &key1) |
GAMSSymbolRecord | findRecord (const std::string &key1, const std::string &key2) |
GAMSSymbolRecord | findRecord (const std::string &key1, const std::string &key2, const std::string &key3) |
GAMSSymbolRecord | mergeRecord (const std::vector< std::string > &keys) |
GAMSSymbolRecord | mergeRecord () |
GAMSSymbolRecord | mergeRecord (const std::string &key1) |
GAMSSymbolRecord | mergeRecord (const std::string &key1, const std::string &key2) |
GAMSSymbolRecord | mergeRecord (const std::string &key1, const std::string &key2, const std::string &key3) |
void | copySymbol (const GAMSSymbol &target) |
gams::GAMSDatabase & | database () const |
Get GAMSDatabase containing the GAMSSymbol. | |
std::string | text () const |
Get explanatory text of GAMSSymbol. | |
std::string & | name () const |
Get GAMSSymbol name. | |
int | dim () const |
Get GAMSSymbol dimension. | |
int | numberRecords () const |
Retrieve the number of records of the GAMSSymbol. | |
LogId | logID () |
GAMSEnum::SymbolType | type () const |
Get the symbol type. | |
Detailed Description
This is the representation of a parameter symbol in GAMS. It exists in a GAMSDatabase and contains GAMSParameterRecords which one can iterate through.
Definition at line 36 of file gamsparameter.h.
Constructor & Destructor Documentation
◆ GAMSParameter() [1/2]
|
inline |
Standard constructor.
Definition at line 42 of file gamsparameter.h.
◆ GAMSParameter() [2/2]
gams::GAMSParameter::GAMSParameter | ( | const GAMSSymbol & | other | ) |
Copy constructor.
- Parameters
-
other Another GAMSSymbol used as data source.
◆ ~GAMSParameter()
gams::GAMSParameter::~GAMSParameter | ( | ) |
Destructor.
Member Function Documentation
◆ addRecord() [1/5]
GAMSParameterRecord gams::GAMSParameter::addRecord | ( | ) |
Add record to GAMSParameter.
- Returns
- Instance of GAMSParameterRecord.
◆ addRecord() [2/5]
GAMSParameterRecord gams::GAMSParameter::addRecord | ( | const std::string & | key1 | ) |
Add record to GAMSParameter.
- Parameters
-
key1 Key for first index position.
- Returns
- Instance of GAMSParameterRecord.
◆ addRecord() [3/5]
GAMSParameterRecord gams::GAMSParameter::addRecord | ( | const std::string & | key1, |
const std::string & | key2 | ||
) |
Add record to GAMSParameter.
- Parameters
-
key1 Key for first index position. key2 Key for second index position.
- Returns
- Instance of GAMSParameterRecord.
◆ addRecord() [4/5]
GAMSParameterRecord gams::GAMSParameter::addRecord | ( | const std::string & | key1, |
const std::string & | key2, | ||
const std::string & | key3 | ||
) |
Add record to GAMSParameter.
- Parameters
-
key1 Key for first index position. key2 Key for second index position. key3 Key for third index position.
- Returns
- Instance of GAMSParameterRecord.
◆ addRecord() [5/5]
GAMSParameterRecord gams::GAMSParameter::addRecord | ( | const std::vector< std::string > & | keys | ) |
Add record to GAMSParameter.
- Parameters
-
keys Vector of keys.
- Returns
- Instance of GAMSParameterRecord.
◆ begin()
GAMSSymbolIter< GAMSParameter > gams::GAMSParameter::begin | ( | ) |
Interator to the begining.
- Returns
- Iterator to the first GAMSParameter.
◆ end()
GAMSSymbolIter< GAMSParameter > gams::GAMSParameter::end | ( | ) |
Iterator to end.
- Returns
- Iterator to the element following the last GAMSParameter.
◆ findRecord() [1/5]
GAMSParameterRecord gams::GAMSParameter::findRecord | ( | ) |
Find record in GAMSParameter.
- Returns
- Instance of GAMSParameterRecord.
◆ findRecord() [2/5]
GAMSParameterRecord gams::GAMSParameter::findRecord | ( | const std::string & | key1 | ) |
Find record in GAMSParameter.
- Parameters
-
key1 Key for first index position.
- Returns
- Instance of GAMSParameterRecord.
◆ findRecord() [3/5]
GAMSParameterRecord gams::GAMSParameter::findRecord | ( | const std::string & | key1, |
const std::string & | key2 | ||
) |
Find record in GAMSParameter.
- Parameters
-
key1 Key for first index position. key2 Key for second index position.
- Returns
- Instance of GAMSParameterRecord.
◆ findRecord() [4/5]
GAMSParameterRecord gams::GAMSParameter::findRecord | ( | const std::string & | key1, |
const std::string & | key2, | ||
const std::string & | key3 | ||
) |
Find record in GAMSParameter.
- Parameters
-
key1 Key for first index position. key2 Key for second index position. key3 Key for third index position.
- Returns
- Instance of GAMSParameterRecord.
◆ findRecord() [5/5]
GAMSParameterRecord gams::GAMSParameter::findRecord | ( | const std::vector< std::string > & | keys | ) |
Find record in GAMSParameter.
- Parameters
-
keys Vector of keys.
- Returns
- Instance of GAMSParameterRecord.
◆ firstRecord() [1/5]
GAMSParameterRecord gams::GAMSParameter::firstRecord | ( | ) |
Retrieve first record in GAMSParameter.
- Returns
- Instance of GAMSParameterRecord.
◆ firstRecord() [2/5]
GAMSParameterRecord gams::GAMSParameter::firstRecord | ( | const std::string & | key1 | ) |
Retrieve first record in GAMSParameter that meets the slice criteria.
- Parameters
-
key1 Slicing criteria for first index position.
- Returns
- Instance of GAMSParameterRecord.
◆ firstRecord() [3/5]
GAMSParameterRecord gams::GAMSParameter::firstRecord | ( | const std::string & | key1, |
const std::string & | key2 | ||
) |
Retrieve first record in GAMSParameter that meets the slice criteria.
- Parameters
-
key1 Slicing criteria for first index position. key2 Slicing criteria for second index position.
- Returns
- Instance of GAMSParameterRecord.
◆ firstRecord() [4/5]
GAMSParameterRecord gams::GAMSParameter::firstRecord | ( | const std::string & | key1, |
const std::string & | key2, | ||
const std::string & | key3 | ||
) |
Retrieve first record in GAMSParameter that meets the slice criteria.
- Parameters
-
key1 Slicing criteria for first index position. key2 Slicing criteria for second index position. key3 Slicing criteria for third index position.
- Returns
- Instance of GAMSParameterRecord.
◆ firstRecord() [5/5]
GAMSParameterRecord gams::GAMSParameter::firstRecord | ( | const std::vector< std::string > & | slice | ) |
Retrieve the first record in GAMSParameter that meets the slice criteria.
- Parameters
-
slice Define filter for elements whose record should be retrieved.
- Returns
- Instance of GAMSParameterRecord.
◆ lastRecord() [1/5]
GAMSParameterRecord gams::GAMSParameter::lastRecord | ( | ) |
Retrieve last record in GAMSParameter.
- Returns
- Instance of GAMSParameterRecord.
◆ lastRecord() [2/5]
GAMSParameterRecord gams::GAMSParameter::lastRecord | ( | const std::string & | key1 | ) |
Retrieve last record in GAMSParameter.
- Parameters
-
key1 Slicing criteria for first index position.
- Returns
- Instance of GAMSParameterRecord.
◆ lastRecord() [3/5]
GAMSParameterRecord gams::GAMSParameter::lastRecord | ( | const std::string & | key1, |
const std::string & | key2 | ||
) |
Retrieve last record in GAMSParameter.
- Parameters
-
key1 Slicing criteria for first index position. key2 Slicing criteria for second index position.
- Returns
- Instance of GAMSParameterRecord.
◆ lastRecord() [4/5]
GAMSParameterRecord gams::GAMSParameter::lastRecord | ( | const std::string & | key1, |
const std::string & | key2, | ||
const std::string & | key3 | ||
) |
Retrieve last record in GAMSParameter.
- Parameters
-
key1 Slicing criteria for first index position. key2 Slicing criteria for second index position. key3 Slicing criteria for third index position.
- Returns
- Instance of GAMSParameterRecord.
◆ lastRecord() [5/5]
GAMSParameterRecord gams::GAMSParameter::lastRecord | ( | const std::vector< std::string > & | slice | ) |
Retrieve a slice of the last record in GAMSParameter.
- Parameters
-
slice Define filter for elements whose record should be retrieved.
- Returns
- Instance of GAMSParameterRecord.
◆ mergeRecord() [1/5]
GAMSParameterRecord gams::GAMSParameter::mergeRecord | ( | ) |
Finds record in GAMSParameter if it exists; otherwise add it.
- Returns
- Instance of found or added GAMSParameterRecord
◆ mergeRecord() [2/5]
GAMSParameterRecord gams::GAMSParameter::mergeRecord | ( | const std::string & | key1 | ) |
Finds record in GAMSParameter if it exists; otherwise add it.
- Parameters
-
key1 Key for first index position.
- Returns
- Instance of found or added GAMSParameterRecord.
◆ mergeRecord() [3/5]
GAMSParameterRecord gams::GAMSParameter::mergeRecord | ( | const std::string & | key1, |
const std::string & | key2 | ||
) |
Finds record in GAMSParameter if it exists; otherwise add it.
- Parameters
-
key1 Key for first index position. key2 Key for second index position.
- Returns
- Instance of found or added GAMSParameterRecord.
◆ mergeRecord() [4/5]
GAMSParameterRecord gams::GAMSParameter::mergeRecord | ( | const std::string & | key1, |
const std::string & | key2, | ||
const std::string & | key3 | ||
) |
Finds record in GAMSParameter if it exists; otherwise add it.
- Parameters
-
key1 Key for first index position. key2 Key for second index position. key3 Key for third index position.
- Returns
- Instance of found or added GAMSParameterRecord.
◆ mergeRecord() [5/5]
GAMSParameterRecord gams::GAMSParameter::mergeRecord | ( | const std::vector< std::string > & | keys | ) |
Finds record in GAMSParameter if it exists; otherwise add it.
- Parameters
-
keys List of keys.
- Returns
- Instance of found or added GAMSParameterRecord.
◆ operator=()
GAMSParameter & gams::GAMSParameter::operator= | ( | const GAMSParameter & | other | ) |
Assigns a GAMSParameter.
- Parameters
-
other Another GAMSParameter used as data source.
- Returns
- Returns the assigned GAMSParameter (*this).