openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc > Class Template Reference

Detailed Description

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>
class openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >

Management class for pluggable wares

Template Parameters

SignatureType	class defining the container for ware signature only
ItemType	class defining the container for ware signature and body
SignatureProc	procedure definition for instantiation of the signature
BodyProc	procedure definition for instantiation of the body

#include <machine/WarePluginsManager.hpp>

Classes
class	PluginsSearchResults

Public Member Functions
virtual	~WarePluginsManager ()
virtual std::string	getPluginFullPath (const std::string &Filename) const =0
virtual std::vector< std::string >	getPluginsSearchPaths () const =0
virtual std::string	getPluginFilenameSuffix () const =0
PluginsSearchResults	getAvailableWaresSignatures (const std::string &Pattern="")
ItemType *	loadWareSignatureOnly (const std::string &ID)
void	completeSignatureWithWareBody (ItemType *WareItem)
void	unloadAllWares ()

Protected Member Functions
	WarePluginsManager ()

Protected Attributes
std::map< std::string, std::unique_ptr< QLibrary > >	m_LoadedPluginsLibraries

Constructor & Destructor Documentation

WarePluginsManager()

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>

openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >::WarePluginsManager ( )

inlineprotected

Default constructor

~WarePluginsManager()

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>

virtual openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >::~WarePluginsManager ( )

inlinevirtual

Member Function Documentation

completeSignatureWithWareBody()

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>

void openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >::completeSignatureWithWareBody ( ItemType *  WareItem )

inline

Loads only the body of a ware if the signature is already loaded

Parameters

[in,out]

WareItem

The ware container to complete which already includes the signature

getAvailableWaresSignatures()

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>

PluginsSearchResults openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >::getAvailableWaresSignatures ( const std::string &  Pattern = "" )

inline

Lists available wares

Parameters

[in]

Pattern

if not empty, the list of available wares is filtered using the given pattern based on wildcard matching

Returns

The list of found wares

getPluginFilenameSuffix()

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>

virtual std::string openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >::getPluginFilenameSuffix ( ) const

pure virtual

Returns the filename suffix for the plugins

Returns

The filename suffix

Implemented in openfluid::machine::SimulatorPluginsManager, and openfluid::machine::ObserverPluginsManager.

getPluginFullPath()

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>

virtual std::string openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >::getPluginFullPath ( const std::string &  Filename ) const

pure virtual

Returns the full path of the plugin from its filename

Parameters

[in]

Filename

The filename of the plugin

Returns

The full path of the plugin, empty if not found

Implemented in openfluid::machine::SimulatorPluginsManager, and openfluid::machine::ObserverPluginsManager.

getPluginsSearchPaths()

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>

virtual std::vector<std::string> openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >::getPluginsSearchPaths ( ) const

pure virtual

Returns ordered search paths for plugins

Returns

The search paths

Implemented in openfluid::machine::SimulatorPluginsManager, and openfluid::machine::ObserverPluginsManager.

loadWareSignatureOnly()

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>

ItemType* openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >::loadWareSignatureOnly ( const std::string &  ID )

inline

Loads only the signature of a ware given by its ID

Parameters

[in]

ID

The ID of the ware to load

Returns

The ware container including the signature

unloadAllWares()

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>

void openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >::unloadAllWares ( )

inline

Unloads all already loaded wares and clears the cache

Member Data Documentation

m_LoadedPluginsLibraries

template<class SignatureType, class ItemType, typename SignatureProc, typename BodyProc>

std::map<std::string,std::unique_ptr<QLibrary> > openfluid::machine::WarePluginsManager< SignatureType, ItemType, SignatureProc, BodyProc >::m_LoadedPluginsLibraries

protected

---

The documentation for this class was generated from the following file:

• machine/WarePluginsManager.hpp