apis/cpp/gamsjob_8h_source.html

/*

  * GAMS - General Algebraic Modeling System C++ API

  *

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

  * Copyright (c) 2017-2022 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 GAMSJOB_H

 #define GAMSJOB_H


 #include "gamslib_global.h"

 #include <string>

 #include <memory>

 #include <vector>

 #include "gamsenum.h"


 namespace gams {


 class GAMSWorkspace;

 class GAMSModelInstance;

 class GAMSJobImpl;

 class GAMSOptions;

 class GAMSCheckpoint;

 class GAMSDatabase;


 class LIBSPEC GAMSJob

 {

 public:

     GAMSJob();


     ~GAMSJob();


     GAMSJob operator=(const GAMSJob& other);


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


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


     bool isValid() const;


     //TODO: complete run methods


     void run();


     void run(std::ostream& outstream);


     void run(GAMSOptions& gamsOptions);


     void run(GAMSOptions& gamsOptions, std::ostream& outstream);


     void run(GAMSOptions& gamsOptions, GAMSDatabase db);


     void run(GAMSCheckpoint gamsCheckpoint);


     void run(GAMSOptions& gamsOptions, GAMSCheckpoint gamsCheckpoint);


     void run(GAMSOptions& gamsOptions, GAMSCheckpoint gamsCheckpoint, std::ostream& output, bool createOutDB

              , std::vector<gams::GAMSDatabase> databases);


     GAMSDatabase outDB();


     std::string name();


     GAMSWorkspace workspace();


     bool interrupt();


     LogId logID();


 private:

     friend class GAMSWorkspaceImpl;

     GAMSJob(const std::shared_ptr<::gams::GAMSJobImpl>& impl);

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

             , const GAMSCheckpoint *checkpoint = 0);


 private:

     std::shared_ptr<::gams::GAMSJobImpl> mImpl;

 };


 } // namespace gams


 #endif // GAMSJOB_H