Documentation for OpenFLUID 2.2.0
openfluid::machine::SimulatorPluginsManager Class Reference

#include <machine/SimulatorPluginsManager.hpp>

Public Member Functions

std::string getPluginFullPath (const std::string &Filename) const
 
std::vector< std::string > getPluginsSearchPaths () const
 
std::string getPluginFilenameSuffix () const
 
std::vector< WareContainer< openfluid::ware::SimulatorSignature > > getAvailableGhosts (const std::string &IDPattern="") const
 
- Public Member Functions inherited from openfluid::machine::WarePluginsManager< openfluid::ware::SimulatorSignature, openfluid::ware::PluggableSimulator, openfluid::ware::GetPluggableSimulatorSignatureProc, openfluid::ware::GetPluggableSimulatorBodyProc >
virtual ~WarePluginsManager ()
 
WareContainer< openfluid::ware::SimulatorSignatureloadPlugin (const std::string &ID)
 
std::vector< WareContainer< openfluid::ware::SimulatorSignature > > loadPlugins (const std::string &IDPattern="")
 
openfluid::ware::PluggableSimulatorgetWareBody (const WareContainer< openfluid::ware::SimulatorSignature > &Container)
 
void unloadAll ()
 

Additional Inherited Members

- Protected Member Functions inherited from openfluid::machine::WarePluginsManager< openfluid::ware::SimulatorSignature, openfluid::ware::PluggableSimulator, openfluid::ware::GetPluggableSimulatorSignatureProc, openfluid::ware::GetPluggableSimulatorBodyProc >
 WarePluginsManager ()
 
- Protected Attributes inherited from openfluid::machine::WarePluginsManager< openfluid::ware::SimulatorSignature, openfluid::ware::PluggableSimulator, openfluid::ware::GetPluggableSimulatorSignatureProc, openfluid::ware::GetPluggableSimulatorBodyProc >
std::map< std::string, std::unique_ptr< DynamicLib > > m_LoadedPluginsLibraries
 
Inheritance diagram for openfluid::machine::SimulatorPluginsManager:
Collaboration diagram for openfluid::machine::SimulatorPluginsManager:

Member Function Documentation

◆ getAvailableGhosts()

std::vector<WareContainer<openfluid::ware::SimulatorSignature> > openfluid::machine::SimulatorPluginsManager::getAvailableGhosts ( const std::string &  IDPattern = "") const

Searches for available ghosts using the standard and user paths

Parameters
[in]IDPatternif not empty, the list of available wares is filtered using the given pattern based on wildcard matching
Returns
the found ghosts

◆ getPluginFilenameSuffix()

std::string openfluid::machine::SimulatorPluginsManager::getPluginFilenameSuffix ( ) const
inlinevirtual

◆ getPluginFullPath()

std::string openfluid::machine::SimulatorPluginsManager::getPluginFullPath ( const std::string &  Filename) const
inlinevirtual

Returns the full path of the plugin from its filename

Parameters
[in]FilenameThe filename of the plugin
Returns
The full path of the plugin, empty if not found

Implements openfluid::machine::WarePluginsManager< openfluid::ware::SimulatorSignature, openfluid::ware::PluggableSimulator, openfluid::ware::GetPluggableSimulatorSignatureProc, openfluid::ware::GetPluggableSimulatorBodyProc >.

◆ getPluginsSearchPaths()

std::vector<std::string> openfluid::machine::SimulatorPluginsManager::getPluginsSearchPaths ( ) const
inlinevirtual

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