gams::GAMSWorkspaceInfo Class Reference

The GAMSWorkspaceInfo can be used to input parameters for the GAMSWorkspace constructor. More...

#include <gamsworkspaceinfo.h>

Public Member Functions

 GAMSWorkspaceInfo (std::string workingDirectory="", std::string systemDirectory="", GAMSEnum::DebugLevel debug=GAMSEnum::DebugLevel::Off)
 
 GAMSWorkspaceInfo (GAMSEnum::DebugLevel debug)
 
bool operator== (const GAMSWorkspaceInfo &other) const
 
bool operator!= (const GAMSWorkspaceInfo &other) const
 
std::string workingDirectory () const
 Get GAMS working directory, i.e. the anchor for all file-based operations. More...
 
void setWorkingDirectory (std::string workingDir)
 
std::string systemDirectory () const
 Get GAMS system directory, i.e. installation directory of the GAMS distribution. More...
 
void setSystemDirectory (std::string systemDir)
 
GAMSEnum::DebugLevel debug () const
 Get GAMS debug level. More...
 
void setDebug (GAMSEnum::DebugLevel debug)
 

Detailed Description

The GAMSWorkspaceInfo can be used to input parameters for the GAMSWorkspace constructor.

Definition at line 37 of file gamsworkspaceinfo.h.

Constructor & Destructor Documentation

◆ GAMSWorkspaceInfo() [1/2]

gams::GAMSWorkspaceInfo::GAMSWorkspaceInfo ( std::string  workingDirectory = "",
std::string  systemDirectory = "",
GAMSEnum::DebugLevel  debug = GAMSEnum::DebugLevel::Off 
)

Constructor

Parameters
workingDirectoryGAMS working directory, anchor for all file-based operations (determined automatically if omitted, in user's temporary folder)
systemDirectoryGAMS system directory (determined automatically if omitted)
debugGAMS Debug Level.

◆ GAMSWorkspaceInfo() [2/2]

gams::GAMSWorkspaceInfo::GAMSWorkspaceInfo ( GAMSEnum::DebugLevel  debug)

Constructor.

Parameters
debugGAMS Debug Level.

Member Function Documentation

◆ debug()

GAMSEnum::DebugLevel gams::GAMSWorkspaceInfo::debug ( ) const

Get GAMS debug level.

◆ operator!=()

bool gams::GAMSWorkspaceInfo::operator!= ( const GAMSWorkspaceInfo other) const

Compares two GAMSWorkspaceInfo objects.

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

◆ operator==()

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

Compares two GAMSWorkspaceInfo objects.

Parameters
otherAnother GAMSWorkspaceInfo to compare to.
Returns
Returns true if the two GAMSWorkspaceInfo are equal; otherwise false.

◆ setDebug()

void gams::GAMSWorkspaceInfo::setDebug ( GAMSEnum::DebugLevel  debug)

Set GAMS debug level.

Parameters
debugGAMS debug level.

◆ setSystemDirectory()

void gams::GAMSWorkspaceInfo::setSystemDirectory ( std::string  systemDir)

Set GAMS system directory, i.e. installation directory of the GAMS distribution.

Parameters
systemDirGAMS system directory.

◆ setWorkingDirectory()

void gams::GAMSWorkspaceInfo::setWorkingDirectory ( std::string  workingDir)

Set GAMS working directory, i.e. the anchor for all file-based operations.

Parameters
workingDirGAMS working directory.

◆ systemDirectory()

std::string gams::GAMSWorkspaceInfo::systemDirectory ( ) const

Get GAMS system directory, i.e. installation directory of the GAMS distribution.

◆ workingDirectory()

std::string gams::GAMSWorkspaceInfo::workingDirectory ( ) const

Get GAMS working directory, i.e. the anchor for all file-based operations.