DE_PluginHolder.hxx File Reference

#include <DE_Wrapper.hxx>
#include <mutex>
#include <tuple>

Data Structures
class	DE_PluginHolder< TheConfType >
	Base class to work with DE_Wrapper global registration of components. Control life-time of current configuration node. In creating stage load into global configuration. On destroying stage unload from global configuration. Operation to load/unload are thread safety. More...
class	DE_MultiPluginHolder< TheConfTypes >
	Helper class for variadic plugin registration. Allows registration of multiple configuration node types simultaneously. More...

Macros
#define	DEPLUGIN(theNodeType, ...)
	Macro to define plugin factory function for DE_Wrapper configuration nodes.

Macro Definition Documentation

DEPLUGIN

#define DEPLUGIN	(		theNodeType,
			... )

Value:

    extern "C" Standard_EXPORT void PLUGINFACTORY()                                                \
    {                                                                                              \
      static DE_MultiPluginHolder<theNodeType, ##__VA_ARGS__> aMultiHolder;                        \
    }

Macro to define plugin factory function for DE_Wrapper configuration nodes.

Parameters

[in]	theNodeType	- first configuration node class to instantiate
[in]	...	- additional configuration node classes to instantiate (optional) Needs to be called after loading of the library to register configuration nodes.

Example of usage:

// Inside implementation of the configuration node source file:
DEPLUGIN(DESTEP_ConfigurationNode)
 
// For multiple node types:
DEPLUGIN(DESTEP_ConfigurationNode, DEIGES_ConfigurationNode, DEVRML_ConfigurationNode)

After loading of the library TKDESTEP:

OSD_SharedLibrary aSharedLibrary("libTKDESTEP.so");
if (!aSharedLibrary.DlOpen(OSD_RTLD_LAZY))
{
  // Error handling
  return;
}
 
typedef void (*PluginFactoryFunc)();
PluginFactoryFunc aFunc = (PluginFactoryFunc)aSharedLibrary.DlSymb("PLUGINFACTORY");
if (aFunc == NULL)
{
  // Error handling
  return;
}
 
aFunc(); // Call factory function to register configuration nodes

Will create instances of all specified configuration nodes and set them to DE_Wrapper global configuration.

Note: if OCCT_NO_PLUGINS is defined, macro does nothing.