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. More...
 
 GAMSDomain (const GAMSSet &set)
 
 GAMSDomain (const std::string &relaxedName)
 
 GAMSDomain (const char *relaxedName)
 
 GAMSDomain (const GAMSDomain &other)
 
GAMSDomainoperator= (const GAMSSet &set)
 
GAMSDomainoperator= (const std::string &relaxedName)
 
GAMSDomainoperator= (const char *relaxedName)
 
GAMSDomainoperator= (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
setThe GAMSSet used as data source.

◆ GAMSDomain() [3/5]

gams::GAMSDomain::GAMSDomain ( const std::string &  relaxedName)

Construtor for a relaxed set.

Parameters
relaxedNameThe relaxed set name used as data source.

◆ GAMSDomain() [4/5]

gams::GAMSDomain::GAMSDomain ( const char *  relaxedName)

Construtor for a relaxed set.

Parameters
relaxedNameThe relaxed set name used as data source.

◆ GAMSDomain() [5/5]

gams::GAMSDomain::GAMSDomain ( const GAMSDomain other)

Copy constructor.

Parameters
otherAnother 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; otherwise false.

◆ isValid()

bool gams::GAMSDomain::isValid ( ) const

Check if a GAMSDomain is valid.

Returns
Returns true if the GAMSCheckpoint is valid; otherwise false.

◆ 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
otherAnother GAMSDomain to compare to.
Returns
Returns true if the two GAMSDomain are equal; otherwise false.

◆ operator=() [1/4]

GAMSDomain& gams::GAMSDomain::operator= ( const GAMSSet set)

Assigns a GAMSSet.

Parameters
setA GAMSSet used as data source.
Returns
Returns the assigned GAMSDomain (*this).

◆ operator=() [2/4]

GAMSDomain& gams::GAMSDomain::operator= ( const std::string &  relaxedName)

Assigns a relaxed set.

Parameters
relaxedNameA relaxed set used as data source.
Returns
Returns the assigned GAMSDomain (*this).

◆ operator=() [3/4]

GAMSDomain& gams::GAMSDomain::operator= ( const char *  relaxedName)

Assigns a relaxed set.

Parameters
relaxedNameA relaxed set used as data source.
Returns
Returns the assigned GAMSDomain (*this).

◆ operator=() [4/4]

GAMSDomain& gams::GAMSDomain::operator= ( const GAMSDomain other)

Assigns a GAMSDomain.

Parameters
otherAnother GAMSDomain used as data source.
Returns
Returns the assigned GAMSDomain (*this).

◆ operator==()

bool gams::GAMSDomain::operator== ( const GAMSDomain other) const

Compares two GAMSDomain.

Parameters
otherAnother GAMSDomain to compare to.
Returns
Returns true if the two GAMSDomain are different; otherwise false.