Tulip
4.0.0
Better Visualization Through Research
|
#include <PluginLister.h>
Public Member Functions | |
template<typename PluginType > | |
std::list< std::string > | availablePlugins () |
template<typename PluginType > | |
PluginType * | getPluginObject (const std::string &name, tlp::PluginContext *context) |
template<typename PluginType > | |
bool | pluginExists (const std::string &pluginName) |
Static Public Member Functions | |
static std::list< std::string > | availablePlugins () |
static void | checkLoadedPluginsDependencies (tlp::PluginLoader *loader) |
static std::list< tlp::Dependency > | getPluginDependencies (std::string name) |
static std::string | getPluginLibrary (const std::string &name) |
static tlp::Plugin * | getPluginObject (const std::string &name, tlp::PluginContext *context) |
static const ParameterDescriptionList | getPluginParameters (std::string name) |
static tlp::PluginLister * | instance () |
static bool | pluginExists (const std::string &pluginName) |
static const Plugin * | pluginInformations (const std::string &name) |
static void | registerPlugin (FactoryInterface *objectFactory) |
static void | removePlugin (const std::string &name) |
Static Public Attributes | |
static PluginLoader * | currentLoader |
Static Protected Member Functions | |
static std::string | getPluginRelease (std::string name) |
Protected Attributes | |
std::map< std::string, PluginDescription > | _plugins |
Static Protected Attributes | |
static PluginLister * | _instance |
The PluginLister class is a singleton used to list plugins currently loaded into Tulip and retrieve informations about them.
This class holds various methods to check informations about plugins currently loaded into Tulip. You can use it to list plugins, get dependencies informations or create an instance of a plugin.
Definition at line 59 of file PluginLister.h.
|
static |
Gets the list of plug-ins that registered themselves in this factory.
|
static |
Checks if all registered plug-ins have their dependencies met.
loader | If there are errors, the loader is informed about them so they can be displayed. |
|
static |
Gets the dependencies of a plug-in.
name | The name of the plug-in to retrieve the dependencies of. |
|
static |
Gets the library from which a plug-in has been loaded.
name | The name of the plug-in to retrieve the library of. |
|
static |
Constructs a plug-in.
name | The name of the plug-in to instantiate. |
p | The context to give to the plug-in. |
|
inline |
Similar to tlp::PluginLister::getPluginObject() but returns a typed instance.
This method instantiate a plugin from its name and returns it casted into the given type.
name | The plugin's name |
context | The context to give to the plugin |
Definition at line 123 of file PluginLister.h.
|
static |
Gets the list of parameters for the given plug-in.
name | The name of the plug-in to retrieve the parameters of. |
|
staticprotected |
Gets the release number of the given plug-in.
name | The name of the plug-in to retrieve the version number of. |
|
static |
Gets the static instance of this class. If not already done, creates it beforehand.
|
inline |
Checks if a plugin of a given type is loaded This method checks the plugin "pluginName" is currently loaded into Tulip and if it's of type PluginType.
PluginType | the class type of the plugin |
pluginName | the name of the plugin |
Definition at line 101 of file PluginLister.h.
|
static |
Checks if a given name is registered in this factory.
pluginName | The name of the plug-in to look for. |
|
static |
Gets more detailed informations about one specific plug-in.
name | The name of the plugin to retrieve informations for. |
|
static |
Registers a plugin into Tulip.
|
static |
Removes a plug-in from this factory. This is usefull when a plug-in has unmet dependencies, or appears more than once.
name | The name of the plug-in to remove. |
|
protected |
Stores the factory, dependencies, and parameters of all the plugins that register into this factory.
Definition at line 221 of file PluginLister.h.