base/PlugFunction.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 __PLUGFUNCTION_HPP__
#define __PLUGFUNCTION_HPP__

#include <string>

#include <boost/filesystem/path.hpp>
#include <glibmm.h>


#include <openfluid/dllexport.hpp>
#include <openfluid/core.hpp>
#include <openfluid/base/SimStatus.hpp>
#include <openfluid/base/ExecMsgs.hpp>
#include <openfluid/base/EnvProperties.hpp>
#include <openfluid/base/FuncSignature.hpp>
#include <openfluid/base/StdoutFileOStream.hpp>




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

#define PLUGFUNCTION_PROC_NAME "GetPlugFunction"

#define PLUGSIGNATURE_PROC_NAME "GetPlugSignature"

#define PLUGSDKVERSION_PROC_NAME "GetPlugSDKVersion"



#define DECLARE_PLUGIN_HOOKS \
  extern "C" \
  { \
    DLLEXPORT std::string GetPlugSDKVersion(); \
    DLLEXPORT openfluid::base::PluggableFunction* GetPlugFunction(); \
    DLLEXPORT openfluid::base::FunctionSignature* GetPlugSignature(); \
  }




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


#define DEFINE_FUNCTION_HOOK(pluginclassname) \
  std::string GetPlugSDKVersion() \
  { \
    return std::string(STRINGIFY(OPENFLUID_VERSION)); \
  } \
  \
  openfluid::base::PluggableFunction* GetPlugFunction() \
  { \
    return new pluginclassname(); \
  }



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

#define DECLARE_UNITS_ORDERED_LOOP(loopid) \
  openfluid::core::UnitsList_t::iterator _M_##loopid##_ordit;\
  openfluid::core::UnitsList_t* _M_##loopid##_UList;


#define DECLARE_GLOBAL_UNITS_ORDERED_LOOP(loopid) \
  openfluid::core::UnitsPtrList_t::iterator _M_##loopid##_ordit;\
  openfluid::core::UnitsPtrList_t* _M_##loopid##_GUList;


#define BEGIN_UNITS_ORDERED_LOOP(loopid,unitclass,unit) \
  _M_##loopid##_UList = mp_CoreData->getUnits(unitclass)->getList(); \
  if (_M_##loopid##_UList != NULL) \
    { \
    for (_M_##loopid##_ordit = _M_##loopid##_UList->begin();_M_##loopid##_ordit != _M_##loopid##_UList->end();++_M_##loopid##_ordit) \
    { \
      unit = &(*_M_##loopid##_ordit);


#define BEGIN_GLOBAL_UNITS_ORDERED_LOOP(loopid,unit) \
  { \
    _M_##loopid##_GUList = mp_CoreData->getUnitsGlobally(); \
    for (_M_##loopid##_ordit = _M_##loopid##_GUList->begin();_M_##loopid##_ordit != _M_##loopid##_GUList->end();++_M_##loopid##_ordit) \
    { \
      unit = (*_M_##loopid##_ordit);


#define APPLY_UNITS_ORDERED_LOOP_THREADED(loopid,unitclass,funcptr,...) \
  _M_##loopid##_UList = mp_CoreData->getUnits(unitclass)->getList(); \
  if (_M_##loopid##_UList != NULL) \
  { \
    _M_##loopid##_ordit = _M_##loopid##_UList->begin(); \
    if (_M_##loopid##_ordit != _M_##loopid##_UList->end()) \
    { \
      openfluid::core::PcsOrd_t _M_##loopid##_pcsord = _M_##loopid##_ordit->getProcessOrder(); \
      while (_M_##loopid##_ordit != _M_##loopid##_UList->end()) \
      { \
        Glib::ThreadPool _M_##loopid##_pool(OPENFLUID_GetFunctionMaxThreads(),true); \
        while (_M_##loopid##_ordit != _M_##loopid##_UList->end() && _M_##loopid##_ordit->getProcessOrder() == _M_##loopid##_pcsord) \
        { \
          openfluid::core::Unit* _M_##loopid##_unit = &(*_M_##loopid##_ordit); \
          _M_##loopid##_pool.push(sigc::bind(sigc::mem_fun(*this,&funcptr),_M_##loopid##_unit, ## __VA_ARGS__)); \
          ++_M_##loopid##_ordit; \
        } \
        _M_##loopid##_pool.shutdown(); \
        if (_M_##loopid##_ordit != _M_##loopid##_UList->end()) _M_##loopid##_pcsord = _M_##loopid##_ordit->getProcessOrder(); \
      } \
    } \
  }


#define APPLY_GLOBAL_UNITS_ORDERED_LOOP_THREADED(loopid,funcptr,...) \
  _M_##loopid##_GUList = mp_CoreData->getUnitsGlobally(); \
  if (_M_##loopid##_GUList != NULL) \
  { \
    _M_##loopid##_ordit = _M_##loopid##_GUList->begin(); \
    if (_M_##loopid##_ordit != _M_##loopid##_GUList->end()) \
    { \
      openfluid::core::PcsOrd_t _M_##loopid##_pcsord = (*_M_##loopid##_ordit)->getProcessOrder(); \
      while (_M_##loopid##_ordit != _M_##loopid##_GUList->end()) \
      { \
        Glib::ThreadPool _M_##loopid##_pool(OPENFLUID_GetFunctionMaxThreads(),true); \
        while (_M_##loopid##_ordit != _M_##loopid##_GUList->end() && (*_M_##loopid##_ordit)->getProcessOrder() == _M_##loopid##_pcsord) \
        { \
          openfluid::core::Unit* _M_##loopid##_unit = (*_M_##loopid##_ordit); \
          _M_##loopid##_pool.push(sigc::bind(sigc::mem_fun(*this,&funcptr),_M_##loopid##_unit, ## __VA_ARGS__)); \
          ++_M_##loopid##_ordit; \
        } \
        _M_##loopid##_pool.shutdown(); \
        if (_M_##loopid##_ordit != _M_##loopid##_GUList->end()) _M_##loopid##_pcsord = (*_M_##loopid##_ordit)->getProcessOrder(); \
      } \
    } \
  }



#define DECLARE_UNITS_LIST_LOOP(loopid) \
  openfluid::core::UnitsPtrList_t::iterator _M_##loopid##_lstit;\


#define BEGIN_UNITS_LIST_LOOP(loopid,ulist,unit) \
  if ((ulist) != NULL) \
  { \
    for(_M_##loopid##_lstit=ulist->begin(); _M_##loopid##_lstit != ulist->end(); _M_##loopid##_lstit++) \
    { \
      unit = *_M_##loopid##_lstit; \


#define DECLARE_EVENT_COLLECTION_LOOP \
  openfluid::core::EventsList_t::iterator _M_EvListiter;

#define BEGIN_EVENT_COLLECTION_LOOP(evlist,evobj) \
  { \
    for(_M_EvListiter=(evlist)->begin(); _M_EvListiter != (evlist)->end(); _M_EvListiter++) \
    { \
      evobj = &(*_M_EvListiter);

#define END_LOOP \
    } \
  }




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


namespace openfluid { namespace base {



class DLLEXPORT PluggableFunction
{

  private:

    openfluid::core::CoreRepository* mp_InternalCoreData;


    openfluid::base::ExecutionMessages* mp_ExecMsgs;


    const openfluid::base::EnvironmentProperties* mp_FunctionEnv;


    openfluid::core::FuncParamsMap_t m_ParamsMap;

    openfluid::base::FuncID_t m_FunctionID;

    unsigned int m_MaxThreads;

    bool m_Initialized;

    static bool IsUnitIDInPtrList(const openfluid::core::UnitsPtrList_t* UnitsList,
                                  const openfluid::core::UnitID_t& ID);

    static std::string generateDotEdge(std::string SrcClass, std::string SrcID,
                                       std::string DestClass, std::string DestID,
                                       std::string Options);


  protected:

    // TODO check if const
    openfluid::core::CoreRepository* mp_CoreData;


    void OPENFLUID_GetVariable(openfluid::core::Unit *UnitPtr,
                               openfluid::core::VariableName_t VarName,
                               openfluid::core::TimeStep_t Step,
                               openfluid::core::ScalarValue *Value);

    void OPENFLUID_GetVariable(openfluid::core::Unit *UnitPtr,
                               openfluid::core::VariableName_t VarName,
                               openfluid::core::TimeStep_t Step,
                               openfluid::core::VectorValue *Value);

    void OPENFLUID_GetInputData(openfluid::core::Unit *UnitPtr,
                                openfluid::core::InputDataName_t InputName,
                                double *Value);

    void OPENFLUID_GetInputData(openfluid::core::Unit *UnitPtr,
                                openfluid::core::InputDataName_t InputName,
                                long *Value);

    void OPENFLUID_GetInputData(openfluid::core::Unit *UnitPtr,
                                openfluid::core::InputDataName_t InputName,
                                std::string *Value);

    void OPENFLUID_SetInputData(openfluid::core::Unit *UnitPtr,
                                const openfluid::core::InputDataName_t& InputName,
                                const double& Value);

    void OPENFLUID_SetInputData(openfluid::core::Unit *UnitPtr,
                                const openfluid::core::InputDataName_t& InputName,
                                const long& Value);

    void OPENFLUID_SetInputData(openfluid::core::Unit *UnitPtr,
                                const openfluid::core::InputDataName_t& InputName,
                                const std::string& Value);


    bool OPENFLUID_IsInputDataExist(openfluid::core::Unit *UnitPtr,
                                    openfluid::core::InputDataName_t InputName);



    bool OPENFLUID_IsVariableExist(openfluid::core::Unit *UnitPtr,
                                    openfluid::core::VariableName_t VarName);

    bool OPENFLUID_IsScalarVariableExist(openfluid::core::Unit *UnitPtr,
                                          openfluid::core::VariableName_t VarName);

    bool OPENFLUID_IsVectorVariableExist(openfluid::core::Unit *UnitPtr,
                                          openfluid::core::VariableName_t VarName);


    bool OPENFLUID_IsVariableExist(openfluid::core::Unit *UnitPtr,
                                    openfluid::core::VariableName_t VarName,
                                    openfluid::core::TimeStep_t Step);

    bool OPENFLUID_IsScalarVariableExist(openfluid::core::Unit *UnitPtr,
                                          openfluid::core::VariableName_t VarName,
                                          openfluid::core::TimeStep_t Step);

    bool OPENFLUID_IsVectorVariableExist(openfluid::core::Unit *UnitPtr,
                                          openfluid::core::VariableName_t VarName,
                                          openfluid::core::TimeStep_t Step);

    void OPENFLUID_AppendVariable(openfluid::core::Unit *UnitPtr,
                                  openfluid::core::VariableName_t VarName,
                                  openfluid::core::ScalarValue Value);

    void OPENFLUID_AppendVariable(openfluid::core::Unit *UnitPtr,
                                  openfluid::core::VariableName_t VarName,
                                  openfluid::core::VectorValue& Value);

    void OPENFLUID_SetVariable(openfluid::core::Unit *UnitPtr,
                               openfluid::core::VariableName_t VarName,
                               openfluid::core::TimeStep_t Step,
                               openfluid::core::ScalarValue Value);

    void OPENFLUID_SetVariable(openfluid::core::Unit *UnitPtr,
                               openfluid::core::VariableName_t VarName,
                               openfluid::core::TimeStep_t Step,
                               openfluid::core::VectorValue Value);

    bool OPENFLUID_GetFunctionParameter(openfluid::core::FuncParamsMap_t Params,
                                        openfluid::core::FuncParamKey_t ParamName,
                                        double *Value);

    bool OPENFLUID_GetFunctionParameter(openfluid::core::FuncParamsMap_t Params,
                                        openfluid::core::FuncParamKey_t ParamName,
                                        long *Value);

    bool OPENFLUID_GetFunctionParameter(openfluid::core::FuncParamsMap_t Params,
                                        openfluid::core::FuncParamKey_t ParamName,
                                        float *Value);

    bool OPENFLUID_GetFunctionParameter(openfluid::core::FuncParamsMap_t Params,
                                        openfluid::core::FuncParamKey_t ParamName,
                                        int *Value);

    bool OPENFLUID_GetFunctionParameter(openfluid::core::FuncParamsMap_t Params,
                                        openfluid::core::FuncParamKey_t ParamName,
                                        std::string *Value);

    bool OPENFLUID_GetFunctionParameter(openfluid::core::FuncParamsMap_t Params,
                                        openfluid::core::FuncParamKey_t ParamName,
                                        std::vector<std::string> *Values);


    bool OPENFLUID_GetFunctionParameter(openfluid::core::FuncParamsMap_t Params,
                                        openfluid::core::FuncParamKey_t ParamName,
                                        std::vector<double> *Values);


    bool OPENFLUID_GetFunctionParameter(openfluid::core::FuncParamsMap_t Params,
                                        openfluid::core::FuncParamKey_t ParamName,
                                        std::vector<long> *Values);


    void OPENFLUID_GetEvents(openfluid::core::Unit *UnitPtr,
                             openfluid::core::DateTime BeginDate,
                             openfluid::core::DateTime EndDate,
                             openfluid::core::EventsCollection* Events);


    void OPENFLUID_AppendEvent(openfluid::core::Unit *UnitPtr,
                               openfluid::core::Event& Ev);



    bool OPENFLUID_IsUnitClassExist(openfluid::core::UnitClass_t ClassName);


    bool OPENFLUID_IsUnitExist(openfluid::core::UnitClass_t ClassName,
                               openfluid::core::UnitID_t ID);

    void OPENFLUID_GetUnitsCount(unsigned int& UnitsCount);

    bool OPENFLUID_GetUnitsCount(const openfluid::core::UnitClass_t ClassName,
                                 unsigned int& UnitsCount);


    bool OPENFLUID_GetUnit(const openfluid::core::UnitClass_t& ClassName,
                           const openfluid::core::UnitID_t& ID,
                           openfluid::core::Unit* aUnit);

    openfluid::core::Unit* OPENFLUID_GetUnit(const openfluid::core::UnitClass_t& ClassName,
                                             const openfluid::core::UnitID_t& ID);

    void OPENFLUID_AddUnit(openfluid::core::UnitClass_t ClassName,
                           openfluid::core::UnitID_t ID,
                           openfluid::core::PcsOrd_t PcsOrder);

    void OPENFLUID_DeleteUnit(openfluid::core::UnitClass_t ClassName,
                              openfluid::core::UnitID_t ID);


    bool OPENFLUID_AddFromToConnection(openfluid::core::UnitClass_t ClassNameFrom,
                                       openfluid::core::UnitID_t IDFrom,
                                       openfluid::core::UnitClass_t ClassNameTo,
                                       openfluid::core::UnitID_t IDTo);

    bool OPENFLUID_AddFromToConnection(openfluid::core::Unit* FromUnit,
                                       openfluid::core::Unit* ToUnit);

    bool OPENFLUID_RemoveFromToConnection(openfluid::core::UnitClass_t ClassNameFrom,
                                          openfluid::core::UnitID_t IDFrom,
                                          openfluid::core::UnitClass_t ClassNameTo,
                                          openfluid::core::UnitID_t IDTo);

    bool OPENFLUID_RemoveFromToConnection(openfluid::core::Unit* FromUnit,
                                          openfluid::core::Unit* ToUnit);


    bool OPENFLUID_AddChildParentConnection(openfluid::core::UnitClass_t ClassNameChild,
                                            openfluid::core::UnitID_t IDChild,
                                            openfluid::core::UnitClass_t ClassNameParent,
                                            openfluid::core::UnitID_t IDParent);

    bool OPENFLUID_AddChildParentConnection(openfluid::core::Unit* ChildUnit,
                                            openfluid::core::Unit* ParentUnit);


    bool OPENFLUID_RemoveChildParentConnection(openfluid::core::UnitClass_t ClassNameChild,
                                                openfluid::core::UnitID_t IDChild,
                                                openfluid::core::UnitClass_t ClassNameParent,
                                                openfluid::core::UnitID_t IDParent);

    bool OPENFLUID_RemoveChildParentConnection(openfluid::core::Unit* ChildUnit,
                                                openfluid::core::Unit* ParentUnit);

    bool OPENFLUID_IsUnitConnectedTo(openfluid::core::Unit* aUnit,
                                     const openfluid::core::UnitClass_t& ClassNameTo,
                                     const openfluid::core::UnitID_t& IDTo);


    bool OPENFLUID_IsUnitConnectedFrom(openfluid::core::Unit* aUnit,
                                       const openfluid::core::UnitClass_t& ClassNameFrom,
                                       const openfluid::core::UnitID_t& IDFrom);


    bool OPENFLUID_IsUnitChildOf(openfluid::core::Unit* aUnit,
                                 const openfluid::core::UnitClass_t& ClassNameParent,
                                 const openfluid::core::UnitID_t& IDParent);


    bool OPENFLUID_IsUnitParentOf(openfluid::core::Unit* aUnit,
                                  const openfluid::core::UnitClass_t& ClassNameChild,
                                  const openfluid::core::UnitID_t& IDChild);


    void OPENFLUID_BuildUnitsMatrix(const openfluid::core::UnitClass_t& UnitsClass,
                                    const unsigned int& ColsNbr,
                                    const unsigned int& RowsNbr);


    void OPENFLUID_ExportUnitsGraphAsDotFile(const std::string& Filename);

    void OPENFLUID_RaiseWarning(std::string Sender, openfluid::core::TimeStep_t TimeStep, std::string Msg);

    void OPENFLUID_RaiseWarning(std::string Sender, std::string Msg);

    void OPENFLUID_RaiseWarning(std::string Sender, std::string Source, openfluid::core::TimeStep_t TimeStep, std::string Msg);

    void OPENFLUID_RaiseWarning(std::string Sender, std::string Source, std::string Msg);


    void OPENFLUID_RaiseError(std::string Sender, openfluid::core::TimeStep_t TimeStep, std::string Msg);

    void OPENFLUID_RaiseError(std::string Sender, std::string Msg);

    void OPENFLUID_RaiseError(std::string Sender, std::string Source, openfluid::core::TimeStep_t TimeStep, std::string Msg);

    void OPENFLUID_RaiseError(std::string Sender, std::string Source, std::string Msg);


    bool OPENFLUID_GetRunEnvironment(std::string Key, std::string *Value);

    bool OPENFLUID_GetRunEnvironment(std::string Key, bool *Value);

    inline unsigned int OPENFLUID_GetFunctionMaxThreads() const { return m_MaxThreads; };

    void OPENFLUID_SetFunctionMaxThreads(const unsigned int& MaxNumThreads);


    StdoutAndFileOutputStream OPENFLUID_Logger;


  public:
    PluggableFunction();

    virtual ~PluggableFunction();


    void initializeFunction(openfluid::core::CoreRepository* CoreData,
                            openfluid::base::ExecutionMessages* ExecMsgs,
                            openfluid::base::EnvironmentProperties* FuncEnv,
                            const unsigned int& MaxThreads,
                            const openfluid::base::FuncID_t& FuncID);




    virtual bool initParams(openfluid::core::FuncParamsMap_t Params)=0;

    virtual bool prepareData()=0;

    virtual bool checkConsistency()=0;


    virtual bool initializeRun(const SimulationInfo* SimInfo)=0;

    virtual bool runStep(const SimulationStatus* SimStatus)=0;

    virtual bool finalizeRun(const SimulationInfo* SimInfo)=0;

};


typedef PluggableFunction* (*GetPluggableFunctionProc)();

typedef FunctionSignature* (*GetSignatureProc)();

typedef std::string (*GetSDKVersionProc)();



} } // namespace openfluid::base



#endif