apis/cpp/gamsdatabase_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 GAMSDATABASE_H

#define GAMSDATABASE_H


#include "gamslib_global.h"

#include <string>

#include <memory>

#include <vector>

#include "gamsenum.h"

#include "gamsexception.h"

#include "gamsdomain.h"

#include "gamsdatabaseiter.h"

#include "gamsdatabasedomainviolation.h"


namespace gams {


class GAMSSymbol;

class GAMSWorkspace;

class GAMSEquation;

class GAMSSet;

class GAMSParameter;

class GAMSVariable;

class GAMSDatabaseImpl;

class GAMSSymbolImpl;


class LIBSPEC GAMSDatabase

{

public:

    GAMSDatabase();


    GAMSDatabase& operator=(const GAMSDatabase& other);


    bool isValid() const;


    GAMSDatabaseIter begin();


    GAMSDatabaseIter end();


    int getNrSymbols();


    void setSuppressAutoDomainChecking(bool value);


    bool suppressAutoDomainChecking();


    std::string name();


    GAMSWorkspace workspace();


    void doExport(const std::string& filePath = "");


    bool checkDomains();


    GAMSSymbol getSymbol(const std::string& name);


    GAMSSet getSet(const std::string& name);


    GAMSParameter getParameter(const std::string& name);


    GAMSVariable getVariable(const std::string& name);


    GAMSEquation getEquation(const std::string& name);


    GAMSSet addSet(const std::string& name, const int dimension, const std::string& explanatoryText = "",

                   GAMSEnum::SetType setType = GAMSEnum::SetType::Multi);


    GAMSSet addSet(const std::string& name, const std::string& explanatoryText

                   , const std::vector<GAMSDomain>& domains = std::vector<GAMSDomain>(),

                   GAMSEnum::SetType setType = GAMSEnum::SetType::Multi);


    GAMSSet addSet(const std::string& name, const std::string& explanatoryText

                   , GAMSDomain domain1, GAMSDomain domain2 = GAMSDomain(), GAMSDomain domain3 = GAMSDomain(), GAMSEnum::SetType setType = GAMSEnum::SetType::Multi);


    GAMSParameter addParameter(const std::string& name, const int dimension, const std::string& explanatoryText = "");


    GAMSParameter addParameter(const std::string& name, const std::string& explanatoryText = ""

                               , const std::vector<GAMSDomain>& domains = std::vector<GAMSDomain>());


    GAMSParameter addParameter(const std::string& name, const std::string& explanatoryText, GAMSDomain domain1

                               , GAMSDomain domain2 = GAMSDomain(), GAMSDomain domain3 = GAMSDomain());


    GAMSVariable addVariable(const std::string& name, const int dimension, const GAMSEnum::VarType varType

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


    GAMSVariable addVariable(const std::string& name, const GAMSEnum::VarType varType, const std::string& explanatoryText = ""

                             , const std::vector<GAMSDomain>& domains = std::vector<GAMSDomain>());


    GAMSVariable addVariable(const std::string& name, const GAMSEnum::VarType varType, const std::string& explanatoryText

                             , GAMSDomain domain1, GAMSDomain domain2 = GAMSDomain(), GAMSDomain domain3 = GAMSDomain());


    GAMSEquation addEquation(const std::string& name, const int dimension, const GAMSEnum::EquType equType

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


    GAMSEquation addEquation(const std::string& name, const GAMSEnum::EquType equType, const std::string& explanatoryText = ""

                             , const std::vector<GAMSDomain>& domains = std::vector<GAMSDomain>());


    GAMSEquation addEquation(const std::string& name, const GAMSEnum::EquType equType, const std::string& explanatoryText

                             , GAMSDomain domain1, GAMSDomain domain2 = GAMSDomain(), GAMSDomain domain3 = GAMSDomain());


    std::vector<GAMSDatabaseDomainViolation> getDatabaseDVs(int maxViol = 0, int maxViolPerSym = 0);


    ~GAMSDatabase();


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


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


    LogId logID();


    void clear();


private:

    friend class GAMSWorkspaceImpl;

    friend class GAMSModelInstanceImpl;

    friend class GAMSJobImpl;

    friend class GAMSSymbolImpl;

    friend class GAMSDatabaseIter;


    GAMSDatabase(const std::shared_ptr<GAMSDatabaseImpl>& impl);

    GAMSDatabase(void* gmdPtr, gams::GAMSWorkspace &workspace);

    GAMSDatabase(const std::string& gdxFileName, gams::GAMSWorkspace& workspace, const double specValues[]

                 , const std::string& databaseName = "", const std::string& inModelName = "", bool forceName = false);

    GAMSDatabase(gams::GAMSWorkspace& workspace, const double specValues[], const std::string& databaseName = ""

            , const std::string& inModelName = "", bool forceName = false);

    GAMSDatabase(gams::GAMSWorkspace &workspace, const double specValues[], const GAMSDatabase& sourceDb

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

    std::string inModelName();


private:

    std::shared_ptr<GAMSDatabaseImpl> mImpl;

};


} // namespace gams


#endif // GAMSDATABASE_H

gams::GAMSDatabaseIter
Definition: gamsdatabaseiter.h:39

gams::GAMSDatabase
Definition: gamsdatabase.h:175

gams::GAMSDatabase::addSet
GAMSSet addSet(const std::string &name, const std::string &explanatoryText, const std::vector< GAMSDomain > &domains=std::vector< GAMSDomain >(), GAMSEnum::SetType setType=GAMSEnum::SetType::Multi)

gams::GAMSDatabase::getEquation
GAMSEquation getEquation(const std::string &name)

gams::GAMSDatabase::clear
void clear()
Clears all GAMSSymbol's of a GAMSDatabase.

gams::GAMSDatabase::addEquation
GAMSEquation addEquation(const std::string &name, const int dimension, const GAMSEnum::EquType equType, const std::string &explanatoryText="")

gams::GAMSDatabase::isValid
bool isValid() const

gams::GAMSDatabase::getDatabaseDVs
std::vector< GAMSDatabaseDomainViolation > getDatabaseDVs(int maxViol=0, int maxViolPerSym=0)

gams::GAMSDatabase::addVariable
GAMSVariable addVariable(const std::string &name, const int dimension, const GAMSEnum::VarType varType, const std::string &explanatoryText="")

gams::GAMSDatabase::addSet
GAMSSet addSet(const std::string &name, const int dimension, const std::string &explanatoryText="", GAMSEnum::SetType setType=GAMSEnum::SetType::Multi)

gams::GAMSDatabase::getNrSymbols
int getNrSymbols()
Retrieve the number of symbols in the GAMSDatabase.

gams::GAMSDatabase::addVariable
GAMSVariable addVariable(const std::string &name, const GAMSEnum::VarType varType, const std::string &explanatoryText="", const std::vector< GAMSDomain > &domains=std::vector< GAMSDomain >())

gams::GAMSDatabase::addParameter
GAMSParameter addParameter(const std::string &name, const int dimension, const std::string &explanatoryText="")

gams::GAMSDatabase::addEquation
GAMSEquation addEquation(const std::string &name, const GAMSEnum::EquType equType, const std::string &explanatoryText, GAMSDomain domain1, GAMSDomain domain2=GAMSDomain(), GAMSDomain domain3=GAMSDomain())

gams::GAMSDatabase::doExport
void doExport(const std::string &filePath="")

gams::GAMSDatabase::GAMSDatabase
GAMSDatabase()
Standard constructor.

gams::GAMSDatabase::addParameter
GAMSParameter addParameter(const std::string &name, const std::string &explanatoryText="", const std::vector< GAMSDomain > &domains=std::vector< GAMSDomain >())

gams::GAMSDatabase::addSet
GAMSSet addSet(const std::string &name, const std::string &explanatoryText, GAMSDomain domain1, GAMSDomain domain2=GAMSDomain(), GAMSDomain domain3=GAMSDomain(), GAMSEnum::SetType setType=GAMSEnum::SetType::Multi)

gams::GAMSDatabase::getSymbol
GAMSSymbol getSymbol(const std::string &name)

gams::GAMSDatabase::getSet
GAMSSet getSet(const std::string &name)

gams::GAMSDatabase::getParameter
GAMSParameter getParameter(const std::string &name)

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

gams::GAMSDatabase::suppressAutoDomainChecking
bool suppressAutoDomainChecking()

gams::GAMSDatabase::checkDomains
bool checkDomains()

gams::GAMSDatabase::addVariable
GAMSVariable addVariable(const std::string &name, const GAMSEnum::VarType varType, const std::string &explanatoryText, GAMSDomain domain1, GAMSDomain domain2=GAMSDomain(), GAMSDomain domain3=GAMSDomain())

gams::GAMSDatabase::setSuppressAutoDomainChecking
void setSuppressAutoDomainChecking(bool value)

gams::GAMSDatabase::logID
LogId logID()

gams::GAMSDatabase::name
std::string name()
Get GAMSDatabase name.

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

gams::GAMSDatabase::workspace
GAMSWorkspace workspace()
Get GAMSWorkspace containing GAMSDatabase.

gams::GAMSDatabase::~GAMSDatabase
~GAMSDatabase()
Destructor.

gams::GAMSDatabase::addEquation
GAMSEquation addEquation(const std::string &name, const GAMSEnum::EquType equType, const std::string &explanatoryText="", const std::vector< GAMSDomain > &domains=std::vector< GAMSDomain >())

gams::GAMSDatabase::getVariable
GAMSVariable getVariable(const std::string &name)

gams::GAMSDatabase::end
GAMSDatabaseIter end()

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

gams::GAMSDatabase::begin
GAMSDatabaseIter begin()

gams::GAMSDatabase::addParameter
GAMSParameter addParameter(const std::string &name, const std::string &explanatoryText, GAMSDomain domain1, GAMSDomain domain2=GAMSDomain(), GAMSDomain domain3=GAMSDomain())

gams::GAMSDomain
This class represents a abstraction of GAMSSet objects and relaxed sets, i.e. strings.
Definition: gamsdomain.h:38

gams::GAMSEnum::VarType
VarType
Variable subtype.
Definition: gamsenum.h:83

gams::GAMSEnum::EquType
EquType
Equation subtype.
Definition: gamsenum.h:58

gams::GAMSEnum::SetType
SetType
Set subtype.
Definition: gamsenum.h:73

gams::GAMSEquation
Definition: gamsequation.h:37

gams::GAMSParameter
Definition: gamsparameter.h:37

gams::GAMSSet
Definition: gamsset.h:37

gams::GAMSSymbol
Definition: gamssymbol.h:49

gams::GAMSVariable
Definition: gamsvariable.h:37

gams::GAMSWorkspace
Definition: gamsworkspace.h:89

gams
Definition: gams.h:91