machine/Engine.hpp

Go to the documentation of this file.

/*
  This file is part of OpenFLUID software
  Copyright (c) 2007-2010 INRA-Montpellier SupAgro


 == GNU General Public License Usage ==

  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  OpenFLUID is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OpenFLUID.  If not, see <http://www.gnu.org/licenses/>.

  In addition, as a special exception, INRA gives You the additional right
  to dynamically link the code of OpenFLUID with code not covered
  under the GNU General Public License ("Non-GPL Code") and to distribute
  linked combinations including the two, subject to the limitations in this
  paragraph. Non-GPL Code permitted under this exception must only link to
  the code of OpenFLUID dynamically through the OpenFLUID libraries
  interfaces, and only for building OpenFLUID plugins. The files of
  Non-GPL Code may be link to the OpenFLUID libraries without causing the
  resulting work to be covered by the GNU General Public License. You must
  obey the GNU General Public License in all respects for all of the
  OpenFLUID code and other code used in conjunction with OpenFLUID
  except the Non-GPL Code covered by this exception. If you modify
  this OpenFLUID, you may extend this exception to your version of the file,
  but you are not obligated to do so. If you do not wish to provide this
  exception without modification, you must delete this exception statement
  from your version and license this OpenFLUID solely under the GPL without
  exception.


 == Other Usage ==

  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
*/


#ifndef __ENGINE_HPP__
#define __ENGINE_HPP__


#include <openfluid/dllexport.hpp>
#include <openfluid/core/TypeDefs.hpp>

namespace openfluid {
namespace base {
class RuntimeEnvironment;
class SimulationStatus;
class SimulationInfo;
}
namespace core {
class Value;
class DateTime;
}
namespace io {
class IOListener;
class OutputsWriter;
class MessagesWriter;
}
}


namespace openfluid { namespace machine {

class PluginManager;
class ModelInstance;
class MachineListener;
class SimulationBlob;


// =====================================================================
// =====================================================================


class DLLEXPORT Engine
{
  public:

    struct PretestInfos_t
    {
      bool Model;
      std::string ModelMsg;

      bool Inputdata;
      std::string InputdataMsg;

      bool ExtraFiles;
      std::string ExtraFilesMsg;

      PretestInfos_t() : Model(true), ModelMsg(""),
          Inputdata(true), InputdataMsg(""),
          ExtraFiles(true), ExtraFilesMsg("")
        { };
    };

  private:

     SimulationBlob& m_SimulationBlob;

     openfluid::base::RuntimeEnvironment* mp_RunEnv;

     openfluid::base::SimulationStatus* mp_SimStatus;



     MachineListener* mp_MachineListener;

     openfluid::io::IOListener* mp_IOListener;

     ModelInstance& m_ModelInstance;

     openfluid::io::OutputsWriter* mp_OutputsWriter;

     openfluid::io::MessagesWriter* mp_MessagesWriter;



     void checkSimulationVarsProduction(int ExpectedVarsCount);

     void checkModelConsistency();

     void checkInputDataConsistency();

     void checkExtraFilesConsistency();

     void checkExistingVariable(openfluid::core::VariableName_t VarName,
                                openfluid::core::Value::Type VarType,
                                openfluid::core::UnitClass_t ClassName,
                                std::string FunctionName);

     void createVariable(openfluid::core::VariableName_t VarName,
                         openfluid::core::Value::Type VarType,
                         openfluid::core::UnitClass_t ClassName,
                         bool UpdateMode,
                         std::string FunctionName);

     void checkExistingInputData(openfluid::core::InputDataName_t DataName,
                                 openfluid::core::UnitClass_t ClassName,
                                 std::string FunctionName);

     void prepareOutputDir();

     void initOutputs();

     void prepareOutputs();

     void saveOutputs(const openfluid::core::DateTime& CurrentDT);

     void saveSimulationInfos();

     void saveSimulationProfile();


  public:
    Engine(SimulationBlob& SimBlob, ModelInstance& MInstance,
           openfluid::machine::MachineListener* MachineListener,
           openfluid::io::IOListener* IOListener);

    ~Engine();


    void pretestConsistency(PretestInfos_t& PretestInfos);

    void initialize();

    void initParams();

    void prepareData();

    void checkConsistency();

    void run();

    void finalize();

    void saveReports();

    void closeOutputs();

    openfluid::base::SimulationInfo* getSimulationInfo() { return (openfluid::base::SimulationInfo*)mp_SimStatus; };

    SimulationBlob*  getSimulationBlob() { return &m_SimulationBlob; };

    MachineListener* getMachineListener() { return mp_MachineListener; };

    openfluid::io::IOListener* getIOListener() { return mp_IOListener; };

    ModelInstance* getModelInstance() { return &m_ModelInstance; };


};


} } //namespaces


#endif