builderext/PluggableBuilderExtension.hpp File Reference

Header of ... More...

Go to the source code of this file.

Classes
class	openfluid::builderext::BuilderExtensionInfos
class	openfluid::builderext::PluggableBuilderExtension
Namespaces
namespace	openfluid
namespace	openfluid::builderext
Defines
#define	EXTENSION_PROC_NAME   "GetExtension"
#define	EXTINFOS_PROC_NAME   "GetExtensionInfos"
#define	EXTSDKVERSION_PROC_NAME   "GetExtensionSDKVersion"
#define	DECLARE_EXTENSION_HOOKS
#define	DEFINE_EXTENSION_HOOKS(pluginclassname)
#define	DEFINE_EXTENSION_INFOS(id, shortname, name, desc, authors, authorsctct)
Typedefs
typedef std::map< std::string, std::string >	openfluid::builderext::ExtensionConfig_t
typedef PluggableBuilderExtension *(*	openfluid::builderext::GetExtensionProc )()
typedef BuilderExtensionInfos(*	openfluid::builderext::GetExtensionInfosProc )()
typedef std::string(*	openfluid::builderext::GetExtensionSDKVersionProc )()

---

Detailed Description

Header of ...

Author:

Jean-Christophe FABRE <fabrejc@supagro.inra.fr>

---

Define Documentation

#define DECLARE_EXTENSION_HOOKS

Value:

extern "C" \
  { \
    DLLEXPORT std::string GetExtensionSDKVersion(); \
    DLLEXPORT openfluid::builderext::PluggableBuilderExtension* GetExtension(); \
    DLLEXPORT openfluid::builderext::BuilderExtensionInfos GetExtensionInfos(); \
  }

Macro for declaration of extension and infos hooks

#define DEFINE_EXTENSION_HOOKS

(

pluginclassname

)

Value:

std::string GetExtensionSDKVersion() \
  { \
    return std::string(STRINGIFY(OPENFLUID_VERSION)); \
  } \
  \
  openfluid::builderext::PluggableBuilderExtension* GetExtension() \
  { \
    return new pluginclassname(); \
  }

Macro for definition of extension hook

Parameters:

[in]

pluginclassname

The name of the class to instanciate

#define DEFINE_EXTENSION_INFOS	(		id,
			shortname,
			name,
			desc,
			authors,
			authorsctct
	)

Value:

openfluid::builderext::BuilderExtensionInfos GetExtensionInfos() \
  { \
    openfluid::builderext::BuilderExtensionInfos BEI; \
    \
    BEI.ID = (id); \
    BEI.ShortName = (shortname); \
    BEI.Name = (name); \
    BEI.Description = (desc); \
    BEI.Authors = (authors); \
    BEI.AuthorsContact = (authorsctct); \
    \
    return BEI; \
  }

#define EXTENSION_PROC_NAME   "GetExtension"

Extension hook name

#define EXTINFOS_PROC_NAME   "GetExtensionInfos"

Infos hook name

#define EXTSDKVERSION_PROC_NAME   "GetExtensionSDKVersion"

SDK version hook name