PluggableFeatureExtension.hpp

Go to the documentation of this file.

/*

  This file is part of OpenFLUID software
  Copyright(c) 2007, 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/>.


 == 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.
  
*/


/**
  @file PluggableFeatureExtension.hpp

  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
*/


#ifndef __OPENFLUID_BUILDEREXT_PLUGGABLEFEATUREEXTENSION_HPP__
#define __OPENFLUID_BUILDEREXT_PLUGGABLEFEATUREEXTENSION_HPP__


#include <openfluid/builderext/FluidXUpdateFlags.hpp>
#include <openfluid/builderext/PluggableBuilderExtension.hpp>


/**
  Macro for the beginning of definition of signature for feature extension

  @cond OpenFLUID:completion
  {
    "contexts" : ["BUILDEREXT"],
    "menupath" : ["Signature"],
    "title" : "Insert signature block",
    "text" : "BEGIN_BUILDEREXT_SIGNATURE(\"%%SEL_START%%bext.id%%SEL_END%%\",exttype)\n\nEND_BUILDEREXT_SIGNATURE"
  }
  @endcond
*/
#ifndef BEGIN_BUILDEREXT_SIGNATURE
#define BEGIN_BUILDEREXT_SIGNATURE(id,extmode) \
  extern "C" { \
  OPENFLUID_PLUGIN openfluid::builderext::BuilderExtensionSignature* WARESIGNATURE_PROC_DECL() \
    { \
      openfluid::builderext::BuilderExtensionSignature* Signature =\
        new openfluid::builderext::BuilderExtensionSignature(); \
      Signature->setABIVersion(openfluid::config::VERSION_FULL); \
      Signature->ID = (id); \
      Signature->Mode = (extmode);\
      Signature->Type = openfluid::builderext::TYPE_FEATURE;
#endif

/**
  Macro for the end of definition of signature hook
*/
#ifndef END_BUILDEREXT_SIGNATURE
#define END_BUILDEREXT_SIGNATURE \
      return Signature; \
    } \
}
#endif


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


/**
  Macro for declaration of a Builder extension configuration parameter
  @param[in] name name of the parameter
  @param[in] description description of the parameter
*/
#define DECLARE_CONFIGURATION_PARAMETER(name,description) \
  Signature->ConfigParameters[(name)] = (description);

/**
  @deprecated Since version 2.1.0. Use #DECLARE_CONFIGURATION_PARAMETER instead
*/
#define DECLARE_CONFIGURATION_PARAM(name,description) DECLARE_CONFIGURATION_PARAMETER(name,description)


/**
  Macro for declaration of the Builder extension category

  @cond OpenFLUID:completion
  {
    "contexts" : ["BUILDEREXT"],
    "menupath" : ["Signature", "Menu context"],
    "title" : "Declare menu category",
    "text" : "DECLARE_CATEGORY(%%SEL_START%%category%%SEL_END%%)"
  }
  @endcond
*/
#define DECLARE_CATEGORY(category) \
  Signature->Category = (category);


/**
  Macro for declaration of the Builder extension menu text

  @cond OpenFLUID:completion
  {
    "contexts" : ["BUILDEREXT"],
    "menupath" : ["Signature", "Menu context"],
    "title" : "Declare menu text",
    "text" : "DECLARE_MENUTEXT(\"%%SEL_START%%menu text%%SEL_END%%\")"
  }
  @endcond
*/
#define DECLARE_MENUTEXT(menutext) \
  Signature->MenuText = (menutext);


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


namespace openfluid { namespace builderext {


class OPENFLUID_API PluggableFeatureExtension : public PluggableBuilderExtension
{

  protected:

    openfluid::fluidx::FluidXDescriptor* mp_Desc;

    openfluid::ware::WareParams_t m_Config;


  public:

    PluggableFeatureExtension() : PluggableBuilderExtension(), mp_Desc(nullptr)
    { }


    virtual ~PluggableFeatureExtension()
    { }


    virtual void setConfiguration(const openfluid::ware::WareParams_t& Config)
    {
      m_Config = Config;
    }


    void setFluidXDescriptor(openfluid::fluidx::FluidXDescriptor* Desc)
    {
      mp_Desc = Desc;
    }


    virtual bool initialize() = 0;
};


} }  // namespaces


#endif /* __OPENFLUID_BUILDEREXT_PLUGGABLEFEATUREEXTENSION_HPP__ */