Tulip
4.10.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) |
Public Member Functions inherited from tlp::Observable | |
void | addListener (Observable *const listener) const |
void | addObserver (Observable *const observer) const |
unsigned int | countListeners () const |
unsigned int | countObservers () const |
unsigned int | getReceived () const |
unsigned int | getSent () const |
void | removeListener (Observable *const listener) const |
void | removeObserver (Observable *const observerver) const |
Static Public Member Functions | |
static std::list< std::string > | availablePlugins () |
static void | checkLoadedPluginsDependencies (tlp::PluginLoader *loader) |
static const std::list< tlp::Dependency > & | getPluginDependencies (const 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 (const std::string &name) |
static tlp::PluginLister * | instance () |
static bool | pluginExists (const std::string &pluginName) |
static const Plugin & | pluginInformation (const std::string &name) |
static const Plugin & | pluginInformations (const std::string &name) |
static void | registerPlugin (FactoryInterface *objectFactory) |
static void | removePlugin (const std::string &name) |
Static Public Member Functions inherited from tlp::Observable | |
static tlp::node | getNode (const tlp::Observable *obs) |
static Observable * | getObject (tlp::node n) |
static const tlp::VectorGraph & | getObservableGraph () |
static unsigned int | getScheduled (tlp::node n) |
static void | holdObservers () |
static bool | isAlive (tlp::node n) |
static unsigned int | observersHoldCounter () |
static void | unholdObservers () |
Static Public Attributes | |
static PluginLoader * | currentLoader |
Additional Inherited Members | |
Protected Member Functions inherited from tlp::Observable | |
Observable (const Observable &) | |
tlp::Iterator< tlp::Observable * > * | getObservables () const |
bool | hasOnlookers () const |
void | notifyObservers () |
void | observableDeleted () |
Observable & | operator= (const Observable &) |
void | sendEvent (const Event &message) |
virtual void | treatEvent (const Event &message) |
virtual void | treatEvents (const std::vector< Event > &events) |
The PluginLister class is a singleton used to list plugins currently loaded into Tulip and retrieve information about them.
This class holds various methods to check information about plugins currently loaded into Tulip. You can use it to list plugins, get dependencies information or create an instance of a plugin.
Definition at line 62 of file PluginLister.h.
|
static |
Gets the list of plugins of a given type (template parameter).
|
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 128 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. |
|
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 110 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 information about one specific plug-in.
name | The name of the plugin to retrieve information for. |
|
static |
Gets more detailed information about one specific plug-in.
name | The name of the plugin to retrieve information 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. |