apis/cpp/gamsmodelinstance_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 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, GAMSModelInstanceOpt miOpt);


    void solve(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(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::solve
void solve(GAMSEnum::SymbolUpdateType updateType, std::ostream &output, GAMSModelInstanceOpt miOpt)

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

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

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::modelStatus
GAMSEnum::ModelStat modelStatus()
Get model state.

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

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

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

gams::GAMSModelInstance::logID
LogId logID()

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

gams::GAMSModelInstance::GAMSModelInstance
GAMSModelInstance()
Standard constructor.

gams::GAMSModifier
Definition: gamsmodifier.h:48

gams::GAMSOptions
Definition: gamsoptions.h:55

gams
Definition: gams.h:91