apis/cpp/gamsmodelinstance_8h_source.html

#ifndef GAMSMODELINSTANCE_H

#define GAMSMODELINSTANCE_H


#include <string>

#include <memory>

#include <vector>

#include "gamsenum.h"

#include "gamsmodifier.h"

#include "gamsmodelinstanceopt.h"


namespace gams {


class GAMSCheckpoint;

class GAMSDatabase;

class GAMSOptions;

class GAMSModelInstanceImpl;


class LIBSPEC GAMSModelInstance

{

public:

    GAMSModelInstance();


    GAMSModelInstance& operator=(const GAMSModelInstance& other);


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


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


    bool isValid() const;


    GAMSDatabase syncDb();


    void instantiate(const std::string& modelDefinition, const gams::GAMSOptions& options

                     , const std::vector<gams::GAMSModifier>& modifiers = { });


    void instantiate(const std::string& modelDefinition, const gams::GAMSOptions& options

                     , const GAMSModifier &modifier1 = GAMSModifier(), const GAMSModifier &modifier2 = GAMSModifier()

                     , const GAMSModifier &modifier3 = GAMSModifier());


    void instantiate(const std::string& modelDefinition, const std::vector<gams::GAMSModifier>& modifiers = { });


    void instantiate(const std::string& modelDefinition, const GAMSModifier &modifier1

                     , const GAMSModifier &modifier2 = GAMSModifier(), const GAMSModifier &modifier3 = GAMSModifier());


    void solve(GAMSEnum::SymbolUpdateType updateType,

               std::ostream &output,

               const GAMSModelInstanceOpt &miOpt);


    void solve(const GAMSModelInstanceOpt &miOpt);


    void solve(std::ostream& output);


    void solve(GAMSEnum::SymbolUpdateType updateType = GAMSEnum::SymbolUpdateType::BaseCase);


    GAMSEnum::ModelStat modelStatus();


    std::string modelStatusAsString();


    GAMSEnum::SolveStat solveStatus();


    std::string solveStatusAsString();


    GAMSModelInstance copyModelInstance(const std::string &modelInstanceName = "");


    void interrupt();


    GAMSCheckpoint checkpoint();


    std::string name();


    LogId logID();


private:

    friend class GAMSCheckpointImpl;

    GAMSModelInstance(const std::shared_ptr<GAMSModelInstanceImpl>& impl);

    GAMSModelInstance(GAMSCheckpoint& checkpoint, const std::string& modelInstanceName = "");


private:

    std::shared_ptr<GAMSModelInstanceImpl> mImpl;

};


} // namespace gams


#endif // GAMSMODELINSTANCE_H

gams::GAMSCheckpoint
Definition gamscheckpoint.h:47

gams::GAMSDatabase
Definition gamsdatabase.h:175

gams::GAMSEnum::SymbolUpdateType
SymbolUpdateType
Symbol update type.
Definition gamsenum.h:208

gams::GAMSEnum::ModelStat
ModelStat
Model Solution Status.
Definition gamsenum.h:119

gams::GAMSEnum::SolveStat
SolveStat
Solver termination condition.
Definition gamsenum.h:101

gams::GAMSModelInstanceOpt
The GAMSModelInstanceOpt can be used to customize the GAMSModelInstance.solve() routine.
Definition gamsmodelinstanceopt.h:39

gams::GAMSModelInstance
Definition gamsmodelinstance.h:126

gams::GAMSModelInstance::solveStatusAsString
std::string solveStatusAsString()
Get solve state as string.

gams::GAMSModelInstance::interrupt
void interrupt()
Send interrupt signal to running GAMSModelInstance.

gams::GAMSModelInstance::copyModelInstance
GAMSModelInstance copyModelInstance(const std::string &modelInstanceName="")

gams::GAMSModelInstance::isValid
bool isValid() const

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

gams::GAMSModelInstance::instantiate
void instantiate(const std::string &modelDefinition, const gams::GAMSOptions &options, const std::vector< gams::GAMSModifier > &modifiers={ })

gams::GAMSModelInstance::solveStatus
GAMSEnum::SolveStat solveStatus()
Get solve state.

gams::GAMSModelInstance::solve
void solve(GAMSEnum::SymbolUpdateType updateType=GAMSEnum::SymbolUpdateType::BaseCase)

gams::GAMSModelInstance::modelStatusAsString
std::string modelStatusAsString()
Get model state as string.

gams::GAMSModelInstance::instantiate
void instantiate(const std::string &modelDefinition, const GAMSModifier &modifier1, const GAMSModifier &modifier2=GAMSModifier(), const GAMSModifier &modifier3=GAMSModifier())

gams::GAMSModelInstance::instantiate
void instantiate(const std::string &modelDefinition, const gams::GAMSOptions &options, const GAMSModifier &modifier1=GAMSModifier(), const GAMSModifier &modifier2=GAMSModifier(), const GAMSModifier &modifier3=GAMSModifier())

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

gams::GAMSModelInstance::checkpoint
GAMSCheckpoint checkpoint()

gams::GAMSModelInstance::instantiate
void instantiate(const std::string &modelDefinition, const std::vector< gams::GAMSModifier > &modifiers={ })

gams::GAMSModelInstance::solve
void solve(std::ostream &output)

gams::GAMSModelInstance::solve
void solve(const GAMSModelInstanceOpt &miOpt)

gams::GAMSModelInstance::modelStatus
GAMSEnum::ModelStat modelStatus()
Get model state.

gams::GAMSModelInstance::name
std::string name()

gams::GAMSModelInstance::solve
void solve(GAMSEnum::SymbolUpdateType updateType, std::ostream &output, const GAMSModelInstanceOpt &miOpt)

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

gams::GAMSModelInstance::logID
LogId logID()

gams::GAMSModelInstance::syncDb
GAMSDatabase syncDb()
Retrieve GAMSDatabase used to synchronize modifiable data.

gams::GAMSModelInstance::GAMSModelInstance
GAMSModelInstance()
Default constructor.

gams::GAMSModifier
Definition gamsmodifier.h:48

gams::GAMSOptions
Definition gamsoptions.h:55

gams
Definition gams.h:91