gams::GAMSSetRecord Class Reference

This is the representation of a single record of a GAMSSet. More...

#include <gamssetrecord.h>

Inheritance diagram for gams::GAMSSetRecord:
gams::GAMSSymbolRecord

Public Member Functions

 GAMSSetRecord ()
 
 GAMSSetRecord (const GAMSSymbolRecord &record)
 
GAMSSetRecordoperator= (const GAMSSetRecord &other)
 
std::string text ()
 
void setText (const std::string &text)
 
- Public Member Functions inherited from gams::GAMSSymbolRecord
 GAMSSymbolRecord ()
 
 GAMSSymbolRecord (const GAMSSymbolRecord &record)
 
virtual ~GAMSSymbolRecord ()
 Destructor. More...
 
GAMSSymbolRecordoperator= (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. More...
 
std::string key (int index)
 
std::string operator[] (int i)
 
LogId logID ()
 
GAMSEnum::SymbolType type () const
 Get the GAMSSymbol type. More...
 

Detailed Description

This is the representation of a single record of a GAMSSet.

Definition at line 36 of file gamssetrecord.h.

Constructor & Destructor Documentation

◆ GAMSSetRecord() [1/2]

gams::GAMSSetRecord::GAMSSetRecord ( )

The default constructor allows to create an uninitialized GAMSSetRecord to be used later in the code. The method isValid() shows if the instance is initialized.

◆ GAMSSetRecord() [2/2]

gams::GAMSSetRecord::GAMSSetRecord ( const GAMSSymbolRecord record)

Copy constructor.

Parameters
recordAnother GAMSSymbolRecord used as data source.

Member Function Documentation

◆ operator=()

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

Assigns a GAMSSetRecord.

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

◆ setText()

void gams::GAMSSetRecord::setText ( const std::string &  text)

Set the explanatory text of this GAMSSetRecord.

Parameters
textExplanatory text.

◆ text()

std::string gams::GAMSSetRecord::text ( )

Retrieve the explanatory text of this GAMSSetRecord.

Returns
Returns the explanatory text.