gams::GAMSDomain Class Reference
This class represents a abstraction of GAMSSet objects and relaxed sets, i.e. strings. More...
#include <gamsdomain.h>
Public Member Functions | |
GAMSDomain () | |
Standard constructor. | |
GAMSDomain (const GAMSSet &set) | |
GAMSDomain (const std::string &relaxedName) | |
GAMSDomain (const char *relaxedName) | |
GAMSDomain (const GAMSDomain &other) | |
GAMSDomain & | operator= (const GAMSSet &set) |
GAMSDomain & | operator= (const std::string &relaxedName) |
GAMSDomain & | operator= (const char *relaxedName) |
GAMSDomain & | operator= (const GAMSDomain &other) |
bool | operator!= (const GAMSDomain &other) const |
bool | operator== (const GAMSDomain &other) const |
GAMSSet | getSet () const |
const std::string & | name () const |
bool | isRelaxed () const |
bool | isValid () const |
Detailed Description
This class represents a abstraction of GAMSSet objects and relaxed sets, i.e. strings.
Definition at line 37 of file gamsdomain.h.
Constructor & Destructor Documentation
◆ GAMSDomain() [1/5]
gams::GAMSDomain::GAMSDomain | ( | ) |
Standard constructor.
◆ GAMSDomain() [2/5]
gams::GAMSDomain::GAMSDomain | ( | const GAMSSet & | set | ) |
Construtor for a GAMSSet.
- Parameters
-
set The GAMSSet used as data source.
◆ GAMSDomain() [3/5]
gams::GAMSDomain::GAMSDomain | ( | const std::string & | relaxedName | ) |
Construtor for a relaxed set.
- Parameters
-
relaxedName The relaxed set name used as data source.
◆ GAMSDomain() [4/5]
gams::GAMSDomain::GAMSDomain | ( | const char * | relaxedName | ) |
Construtor for a relaxed set.
- Parameters
-
relaxedName The relaxed set name used as data source.
◆ GAMSDomain() [5/5]
gams::GAMSDomain::GAMSDomain | ( | const GAMSDomain & | other | ) |
Copy constructor.
- Parameters
-
other Another GAMSDomain used as data source.
Member Function Documentation
◆ getSet()
GAMSSet gams::GAMSDomain::getSet | ( | ) | const |
Get the GAMSSet.
- Remarks
- This function throws an exception if it is called on an relaxed domain.
- Returns
- Returns the GAMSSet of a non relaxed domain.
◆ isRelaxed()
bool gams::GAMSDomain::isRelaxed | ( | ) | const |
Indicates if a GAMSDomain is a relaxed set.
- Returns
- Returns
true
if the GAMSDomain is relaxed; otherwisefalse
.
◆ isValid()
bool gams::GAMSDomain::isValid | ( | ) | const |
Check if a GAMSDomain is valid.
- Returns
- Returns
true
if the GAMSCheckpoint is valid; otherwisefalse
.
◆ name()
const std::string & gams::GAMSDomain::name | ( | ) | const |
Get the set name.
- Returns
- Returns the name.
◆ operator!=()
bool gams::GAMSDomain::operator!= | ( | const GAMSDomain & | other | ) | const |
Compares two GAMSDomain objects.
- Parameters
-
other Another GAMSDomain to compare to.
- Returns
- Returns
true
if the two GAMSDomain are equal; otherwisefalse
.
◆ operator=() [1/4]
GAMSDomain & gams::GAMSDomain::operator= | ( | const char * | relaxedName | ) |
Assigns a relaxed set.
- Parameters
-
relaxedName A relaxed set used as data source.
- Returns
- Returns the assigned GAMSDomain (*this).
◆ operator=() [2/4]
GAMSDomain & gams::GAMSDomain::operator= | ( | const GAMSDomain & | other | ) |
Assigns a GAMSDomain.
- Parameters
-
other Another GAMSDomain used as data source.
- Returns
- Returns the assigned GAMSDomain (*this).
◆ operator=() [3/4]
GAMSDomain & gams::GAMSDomain::operator= | ( | const GAMSSet & | set | ) |
Assigns a GAMSSet.
- Parameters
-
set A GAMSSet used as data source.
- Returns
- Returns the assigned GAMSDomain (*this).
◆ operator=() [4/4]
GAMSDomain & gams::GAMSDomain::operator= | ( | const std::string & | relaxedName | ) |
Assigns a relaxed set.
- Parameters
-
relaxedName A relaxed set used as data source.
- Returns
- Returns the assigned GAMSDomain (*this).
◆ operator==()
bool gams::GAMSDomain::operator== | ( | const GAMSDomain & | other | ) | const |
Compares two GAMSDomain.
- Parameters
-
other Another GAMSDomain to compare to.
- Returns
- Returns
true
if the two GAMSDomain are different; otherwisefalse
.