GamsDictionary Class Reference

Class to provide access to a GAMS dictionary. More...

#include <GamsDictionary.hpp>

Collaboration diagram for GamsDictionary:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 GamsDictionary (GamsHandler &gams_)
 Constructor.
 ~GamsDictionary ()
 Destructor.
bool readDictionary ()
 Reads the GAMS dictionary.
bool haveNames ()
 Indicates whether a dictionary has been successfully read.
char * getColName (int colnr, char *buffer, int bufLen)
 The name of a column.
char * getRowName (int rownr, char *buffer, int bufLen)
 The name of a row.
char * getObjName (char *buffer, int bufLen)
 The name of the objective.
char * getColText (int colnr, char *buffer, int bufLen)
 The descriptive text of a column.
char * getRowText (int rownr, char *buffer, int bufLen)
 The descriptive text of a row.
char * getObjText (char *buffer, int bufLen)
 The descriptive text of the objective.

Private Member Functions

char * constructName (char *buffer, int bufLen, int lSym, int *uelIndices, int nIndices)

Private Attributes

GamsHandlergams
dictRec * dict

Friends

class GamsBCH
class GamsGDX

Detailed Description

Class to provide access to a GAMS dictionary.

Definition at line 23 of file GamsDictionary.hpp.


Constructor & Destructor Documentation

GamsDictionary::GamsDictionary ( GamsHandler gams_  ) 

Constructor.

Parameters:
gams_ A GamsHandler that gives access to the GAMS dictionary file.

GamsDictionary::~GamsDictionary (  ) 

Destructor.


Member Function Documentation

char* GamsDictionary::constructName ( char *  buffer,
int  bufLen,
int  lSym,
int *  uelIndices,
int  nIndices 
) [private]

bool GamsDictionary::readDictionary (  ) 

Reads the GAMS dictionary.

Returns:
True if successfull, false otherwise.

bool GamsDictionary::haveNames (  )  [inline]

Indicates whether a dictionary has been successfully read.

Definition at line 50 of file GamsDictionary.hpp.

References dict.

char* GamsDictionary::getColName ( int  colnr,
char *  buffer,
int  bufLen 
)

The name of a column.

Parameters:
colnr column index
buffer a buffer for writing the name in
bufLen length of the buffer
Returns:
buffer on success, NULL on failure

char* GamsDictionary::getRowName ( int  rownr,
char *  buffer,
int  bufLen 
)

The name of a row.

Parameters:
rownr row index
buffer a buffer for writing the name in
bufLen length of the buffer
Returns:
buffer on success, NULL on failure

char* GamsDictionary::getObjName ( char *  buffer,
int  bufLen 
)

The name of the objective.

Parameters:
buffer a buffer for writing the name in
bufLen length of the buffer
Returns:
buffer on success, NULL on failure

char* GamsDictionary::getColText ( int  colnr,
char *  buffer,
int  bufLen 
)

The descriptive text of a column.

Parameters:
colnr col index
buffer a buffer for writing the name in
bufLen length of the buffer
Returns:
buffer on success, NULL on failure

char* GamsDictionary::getRowText ( int  rownr,
char *  buffer,
int  bufLen 
)

The descriptive text of a row.

Parameters:
rownr row index
buffer a buffer for writing the name in
bufLen length of the buffer
Returns:
buffer on success, NULL on failure

char* GamsDictionary::getObjText ( char *  buffer,
int  bufLen 
)

The descriptive text of the objective.

Parameters:
buffer a buffer for writing the name in
bufLen length of the buffer
Returns:
buffer on success, NULL on failure


Friends And Related Function Documentation

friend class GamsBCH [friend]

Definition at line 24 of file GamsDictionary.hpp.

friend class GamsGDX [friend]

Definition at line 25 of file GamsDictionary.hpp.


Member Data Documentation

GamsHandler& GamsDictionary::gams [private]

Definition at line 27 of file GamsDictionary.hpp.

struct dictRec* GamsDictionary::dict [private]

Definition at line 29 of file GamsDictionary.hpp.

Referenced by haveNames().


The documentation for this class was generated from the following file:
Generated on Tue Dec 30 03:01:28 2008 for GAMSlinks by  doxygen 1.4.7