apis/cpp/gamsworkspace_8h_source.html

/*

 * GAMS - General Algebraic Modeling System C++ API

 *

 * Copyright (c) 2017-2024 GAMS Software GmbH <support@gams.com>

 * Copyright (c) 2017-2024 GAMS Development Corp. <support@gams.com>

 *

 * Permission is hereby granted, free of charge, to any person obtaining a copy

 * of this software and associated documentation files (the "Software"), to deal

 * in the Software without restriction, including without limitation the rights

 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the Software is

 * furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be included in all

 * copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

 * SOFTWARE.

 */


#ifndef GAMSWORKSPACE_H

#define GAMSWORKSPACE_H


#include <memory>

#include "gamslib_global.h"

#include "gamsenum.h"

#include "gamsworkspaceinfo.h"


namespace gams {


class GAMSDatabase;

class GAMSCheckpoint;

class GAMSOptions;

class GAMSWorkspaceImpl;

class GAMSJob;


class LIBSPEC GAMSWorkspace

{

public:

    GAMSWorkspace();


    GAMSWorkspace(const std::string& workingDir, const std::string& systemDir, GAMSEnum::DebugLevel debug);


    GAMSWorkspace(const std::string& workingDir, const std::string& systemDir = "");


    GAMSWorkspace(const std::string& workingDir, GAMSEnum::DebugLevel debug);


    GAMSWorkspace(GAMSEnum::DebugLevel debug);


    GAMSWorkspace(const GAMSWorkspace& other);


    GAMSWorkspace(const GAMSWorkspaceInfo& wsInfo);


    ~GAMSWorkspace();


    GAMSWorkspace& operator=(const GAMSWorkspace& other);


    std::string version();


    int majorRelNumber();


    int minorRelNumber();


    int goldRelNumber();


    static std::string apiVersionDetail();


    static std::string apiVersion();


    static int apiMajorRelNumber();


    static int apiMinorRelNumber();


    static int apiGoldRelNumber();


    std::string scratchFilePrefix() const;


    void setScratchFilePrefix(std::string prefix);


    double myEPS();


    void setMyEPS(double eps);


    GAMSDatabase addDatabaseFromGDX(const std::string& gdxFileName, const std::string& databaseName

                                    , const std::string& inModelName);


    GAMSDatabase addDatabaseFromGDX(const std::string& gdxFileName, const std::string& databaseName);


    GAMSDatabase addDatabaseFromGDX(const std::string& gdxFileName);


    // TODO(JM): experimental (keep this?)

    GAMSDatabase addDatabaseFromGMD(void* gmdPtr);


    GAMSDatabase addDatabase(const std::string& databaseName = "", const std::string& inModelName = "");


    GAMSDatabase addDatabase(const GAMSDatabase& sourceDatabase, const std::string& databaseName = ""

                             , const std::string& inModelName = "");


    GAMSCheckpoint addCheckpoint(const std::string& checkpointName = "");


    GAMSJob addJobFromFile(const std::string& fileName, const std::string& jobName = "");


    GAMSJob addJobFromFile(const std::string& fileName, const GAMSCheckpoint& checkpoint, const std::string& jobName = "");


    GAMSJob addJobFromString(const std::string& gamsSource, const std::string& jobName = "");


    GAMSJob addJobFromString(const std::string& gamsSource, const GAMSCheckpoint& checkpoint, const std::string& jobName = "");


    GAMSJob addJobFromGamsLib(const std::string& model, const std::string& jobName = "");


    GAMSJob addJobFromGamsLib(const std::string& model, const GAMSCheckpoint& checkpoint, const std::string& jobName = "");


    GAMSJob addJobFromApiLib(const std::string& model, const std::string& jobName = "");


    GAMSJob addJobFromApiLib(const std::string& model, const GAMSCheckpoint& checkpoint, const std::string& jobName = "");


    GAMSJob addJobFromTestLib(const std::string& model, const std::string& jobName = "");


    GAMSJob addJobFromTestLib(const std::string& model, const GAMSCheckpoint& checkpoint, const std::string& jobName = "");


    GAMSJob addJobFromEmpLib(const std::string& model, const std::string& jobName = "");


    GAMSJob addJobFromEmpLib(const std::string& model, const GAMSCheckpoint& checkpoint, const std::string& jobName = "");


    GAMSJob addJobFromDataLib(const std::string& model, const std::string& jobName = "");


    GAMSJob addJobFromDataLib(const std::string& model, const GAMSCheckpoint& checkpoint, const std::string& jobName = "");


    GAMSJob addJobFromFinLib(const std::string& model, const std::string& jobName = "");


    GAMSJob addJobFromFinLib(const std::string& model, const GAMSCheckpoint& checkpoint, const std::string& jobName = "");


    GAMSJob addJobFromNoaLib(const std::string& model, const std::string& jobName = "");


    GAMSJob addJobFromNoaLib(const std::string& model, const GAMSCheckpoint& checkpoint, const std::string& jobName = "");


    GAMSJob addJobFromPsoptLib(const std::string& model, const std::string& jobName = "");


    GAMSJob addJobFromPsoptLib(const std::string& model, const GAMSCheckpoint& checkpoint, const std::string& jobName = "");


    GAMSOptions addOptions();


    GAMSOptions addOptions(const GAMSOptions& optFrom);


    GAMSOptions addOptions(const std::string& optFile);


    void gamsLib(std::string model);


    void testLib(std::string model);


    void empLib(std::string model);


    void dataLib(std::string model);


    void apiLib(std::string model);


    void finLib(std::string model);


    void noaLib(std::string model);


    void psoptLib(std::string model);


    std::string workingDirectory() const;


    std::string systemDirectory() const;


    bool operator==(const GAMSWorkspace& other) const;


    bool operator!=(const GAMSWorkspace& other) const;


    GAMSEnum::DebugLevel debug();


    LogId logID() const;


    double* specValues() const;


    bool hasError() const;


    void setHasError(bool newHasError);


private:

    friend class GAMSModelInstanceImpl;

    friend class GAMSJobImpl;

    friend class GAMSDatabaseImpl;

    friend class GAMSCheckpointImpl;


    GAMSDatabase addDatabaseFromGDXForcedName(std::string gdxFileName, std::string databaseName, std::string inModelName = "");


    bool usingTmpWorkingDir() const;


    std::string registerDatabase(const std::string databaseName = "") const;

    std::string nextDatabaseName() const;


    std::string registerCheckpoint(const std::string &checkpointName = "") const;


    std::string registerModelInstance(const std::string modelInstanceName = "");


    std::string optFileExtension(int optfile); // TODO(JM) check if this method can stay here


private:

    std::shared_ptr<GAMSWorkspaceImpl> mImpl;

};


} // namespace gams


#endif // GAMSWORKSPACE_H

gams::GAMSCheckpoint
Definition: gamscheckpoint.h:47

gams::GAMSDatabase
Definition: gamsdatabase.h:175

gams::GAMSEnum::DebugLevel
DebugLevel
GAMS Debug Level.
Definition: gamsenum.h:198

gams::GAMSJob
Definition: gamsjob.h:61

gams::GAMSOptions
Definition: gamsoptions.h:55

gams::GAMSWorkspaceInfo
The GAMSWorkspaceInfo can be used to input parameters for the GAMSWorkspace constructor.
Definition: gamsworkspaceinfo.h:38

gams::GAMSWorkspace
Definition: gamsworkspace.h:89

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

gams::GAMSWorkspace::addJobFromPsoptLib
GAMSJob addJobFromPsoptLib(const std::string &model, const GAMSCheckpoint &checkpoint, const std::string &jobName="")

gams::GAMSWorkspace::addJobFromNoaLib
GAMSJob addJobFromNoaLib(const std::string &model, const std::string &jobName="")

gams::GAMSWorkspace::addJobFromGamsLib
GAMSJob addJobFromGamsLib(const std::string &model, const std::string &jobName="")

gams::GAMSWorkspace::addJobFromDataLib
GAMSJob addJobFromDataLib(const std::string &model, const std::string &jobName="")

gams::GAMSWorkspace::GAMSWorkspace
GAMSWorkspace(const GAMSWorkspace &other)
Copy Constructor.

gams::GAMSWorkspace::addJobFromGamsLib
GAMSJob addJobFromGamsLib(const std::string &model, const GAMSCheckpoint &checkpoint, const std::string &jobName="")

gams::GAMSWorkspace::finLib
void finLib(std::string model)

gams::GAMSWorkspace::addJobFromTestLib
GAMSJob addJobFromTestLib(const std::string &model, const GAMSCheckpoint &checkpoint, const std::string &jobName="")

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

gams::GAMSWorkspace::myEPS
double myEPS()

gams::GAMSWorkspace::GAMSWorkspace
GAMSWorkspace(const std::string &workingDir, const std::string &systemDir, GAMSEnum::DebugLevel debug)

gams::GAMSWorkspace::addJobFromEmpLib
GAMSJob addJobFromEmpLib(const std::string &model, const GAMSCheckpoint &checkpoint, const std::string &jobName="")

gams::GAMSWorkspace::specValues
double * specValues() const
Get all special values related to a system.

gams::GAMSWorkspace::apiGoldRelNumber
static int apiGoldRelNumber()
Get the GAMS C++ API GOLD release number.

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

gams::GAMSWorkspace::noaLib
void noaLib(std::string model)

gams::GAMSWorkspace::goldRelNumber
int goldRelNumber()
Get the GAMS GOLD release number.

gams::GAMSWorkspace::dataLib
void dataLib(std::string model)

gams::GAMSWorkspace::logID
LogId logID() const

gams::GAMSWorkspace::hasError
bool hasError() const

gams::GAMSWorkspace::addOptions
GAMSOptions addOptions()

gams::GAMSWorkspace::addJobFromFinLib
GAMSJob addJobFromFinLib(const std::string &model, const GAMSCheckpoint &checkpoint, const std::string &jobName="")

gams::GAMSWorkspace::psoptLib
void psoptLib(std::string model)

gams::GAMSWorkspace::GAMSWorkspace
GAMSWorkspace(const std::string &workingDir, const std::string &systemDir="")

gams::GAMSWorkspace::~GAMSWorkspace
~GAMSWorkspace()
Destructor.

gams::GAMSWorkspace::empLib
void empLib(std::string model)

gams::GAMSWorkspace::addJobFromNoaLib
GAMSJob addJobFromNoaLib(const std::string &model, const GAMSCheckpoint &checkpoint, const std::string &jobName="")

gams::GAMSWorkspace::addJobFromApiLib
GAMSJob addJobFromApiLib(const std::string &model, const GAMSCheckpoint &checkpoint, const std::string &jobName="")

gams::GAMSWorkspace::gamsLib
void gamsLib(std::string model)

gams::GAMSWorkspace::apiMajorRelNumber
static int apiMajorRelNumber()
Get the GAMS C++ API major release number.

gams::GAMSWorkspace::setMyEPS
void setMyEPS(double eps)

gams::GAMSWorkspace::scratchFilePrefix
std::string scratchFilePrefix() const
Get the string used to prefix automatically generated files.

gams::GAMSWorkspace::addOptions
GAMSOptions addOptions(const std::string &optFile)

gams::GAMSWorkspace::addJobFromString
GAMSJob addJobFromString(const std::string &gamsSource, const GAMSCheckpoint &checkpoint, const std::string &jobName="")

gams::GAMSWorkspace::addDatabase
GAMSDatabase addDatabase(const GAMSDatabase &sourceDatabase, const std::string &databaseName="", const std::string &inModelName="")

gams::GAMSWorkspace::addJobFromFinLib
GAMSJob addJobFromFinLib(const std::string &model, const std::string &jobName="")

gams::GAMSWorkspace::setHasError
void setHasError(bool newHasError)

gams::GAMSWorkspace::setScratchFilePrefix
void setScratchFilePrefix(std::string prefix)

gams::GAMSWorkspace::addJobFromEmpLib
GAMSJob addJobFromEmpLib(const std::string &model, const std::string &jobName="")

gams::GAMSWorkspace::operator==
bool operator==(const GAMSWorkspace &other) const

gams::GAMSWorkspace::minorRelNumber
int minorRelNumber()
Get the required GAMS minor version number.

gams::GAMSWorkspace::addJobFromFile
GAMSJob addJobFromFile(const std::string &fileName, const GAMSCheckpoint &checkpoint, const std::string &jobName="")

gams::GAMSWorkspace::addJobFromFile
GAMSJob addJobFromFile(const std::string &fileName, const std::string &jobName="")

gams::GAMSWorkspace::addJobFromTestLib
GAMSJob addJobFromTestLib(const std::string &model, const std::string &jobName="")

gams::GAMSWorkspace::GAMSWorkspace
GAMSWorkspace(GAMSEnum::DebugLevel debug)

gams::GAMSWorkspace::addDatabaseFromGDX
GAMSDatabase addDatabaseFromGDX(const std::string &gdxFileName, const std::string &databaseName)

gams::GAMSWorkspace::debug
GAMSEnum::DebugLevel debug()
Get GAMS debug level.

gams::GAMSWorkspace::apiVersion
static std::string apiVersion()

gams::GAMSWorkspace::addJobFromString
GAMSJob addJobFromString(const std::string &gamsSource, const std::string &jobName="")

gams::GAMSWorkspace::addDatabase
GAMSDatabase addDatabase(const std::string &databaseName="", const std::string &inModelName="")

gams::GAMSWorkspace::apiVersionDetail
static std::string apiVersionDetail()

gams::GAMSWorkspace::GAMSWorkspace
GAMSWorkspace()
Constructor.

gams::GAMSWorkspace::apiMinorRelNumber
static int apiMinorRelNumber()
Get the GAMS C++ API minor release number.

gams::GAMSWorkspace::GAMSWorkspace
GAMSWorkspace(const GAMSWorkspaceInfo &wsInfo)

gams::GAMSWorkspace::addDatabaseFromGMD
GAMSDatabase addDatabaseFromGMD(void *gmdPtr)

gams::GAMSWorkspace::majorRelNumber
int majorRelNumber()
Get the required GAMS major version number.

gams::GAMSWorkspace::addJobFromPsoptLib
GAMSJob addJobFromPsoptLib(const std::string &model, const std::string &jobName="")

gams::GAMSWorkspace::version
std::string version()
Get the required GAMS version.

gams::GAMSWorkspace::operator!=
bool operator!=(const GAMSWorkspace &other) const

gams::GAMSWorkspace::addJobFromApiLib
GAMSJob addJobFromApiLib(const std::string &model, const std::string &jobName="")

gams::GAMSWorkspace::GAMSWorkspace
GAMSWorkspace(const std::string &workingDir, GAMSEnum::DebugLevel debug)

gams::GAMSWorkspace::addOptions
GAMSOptions addOptions(const GAMSOptions &optFrom)

gams::GAMSWorkspace::apiLib
void apiLib(std::string model)

gams::GAMSWorkspace::addJobFromDataLib
GAMSJob addJobFromDataLib(const std::string &model, const GAMSCheckpoint &checkpoint, const std::string &jobName="")

gams::GAMSWorkspace::addDatabaseFromGDX
GAMSDatabase addDatabaseFromGDX(const std::string &gdxFileName, const std::string &databaseName, const std::string &inModelName)

gams::GAMSWorkspace::testLib
void testLib(std::string model)

gams::GAMSWorkspace::addDatabaseFromGDX
GAMSDatabase addDatabaseFromGDX(const std::string &gdxFileName)

gams::GAMSWorkspace::addCheckpoint
GAMSCheckpoint addCheckpoint(const std::string &checkpointName="")

gams
Definition: gams.h:91