Used to load ParaView plugins. More...
#include <vtkPVPluginLoader.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | LoadPluginConfigurationXMLFromString (const char *xmlcontents) |
| void | LoadPluginsFromPluginSearchPath () |
| void | LoadPluginsFromPath (const char *path) |
| bool | LoadPlugin (const char *filename) |
| bool | LoadPluginSilently (const char *filename) |
| virtual char * | GetFileName () |
| virtual char * | GetPluginName () |
| virtual char * | GetPluginVersion () |
| virtual char * | GetErrorString () |
| virtual char * | GetSearchPaths () |
| virtual bool | GetLoaded () |
Static Public Member Functions | |
| static vtkPVPluginLoader * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkPVPluginLoader * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkPVPluginLoader () | |
| ~vtkPVPluginLoader () | |
| bool | LoadPluginInternal (const char *filename, bool no_errors) |
| bool | LoadPlugin (const char *file, vtkPVPlugin *plugin) |
| virtual void | SetErrorString (const char *) |
| virtual void | SetPluginName (const char *) |
| virtual void | SetPluginVersion (const char *) |
| virtual void | SetFileName (const char *) |
| virtual void | SetSearchPaths (const char *) |
Protected Attributes | |
| char * | ErrorString |
| char * | PluginName |
| char * | PluginVersion |
| char * | FileName |
| char * | SearchPaths |
| bool | DebugPlugin |
| bool | Loaded |
Detailed Description
Used to load ParaView plugins.
vtkPVPluginLoader can be used to load plugins for ParaView. vtkPVPluginLoader loads the plugin on the local process. For verbose details during the process of loading the plugin, try setting the environment variable PV_PLUGIN_DEBUG. This class only needed when loading plugins from shared libraries dynamically. For statically importing plugins, one directly uses PV_PLUGIN_IMPORT() macro defined in vtkPVPlugin.h.
Definition at line 36 of file vtkPVPluginLoader.h.
Constructor & Destructor Documentation
| vtkPVPluginLoader::vtkPVPluginLoader | ( | ) | [protected] |
| vtkPVPluginLoader::~vtkPVPluginLoader | ( | ) | [protected] |
Member Function Documentation
| static vtkPVPluginLoader* vtkPVPluginLoader::New | ( | ) | [static] |
Reimplemented from vtkObject.
| virtual const char* vtkPVPluginLoader::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
| static vtkPVPluginLoader* vtkPVPluginLoader::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
| void vtkPVPluginLoader::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkObject.
| bool vtkPVPluginLoader::LoadPlugin | ( | const char * | filename | ) | [inline] |
Tries to the load the plugin given the path to the plugin file.
Definition at line 45 of file vtkPVPluginLoader.h.
| bool vtkPVPluginLoader::LoadPluginSilently | ( | const char * | filename | ) | [inline] |
Tries to the load the plugin given the path to the plugin file.
Definition at line 47 of file vtkPVPluginLoader.h.
| void vtkPVPluginLoader::LoadPluginConfigurationXMLFromString | ( | const char * | xmlcontents | ) |
Simply forwards the call to vtkPVPluginLoader::LoadPluginConfigurationXMLFromString to load configuration xml.
| void vtkPVPluginLoader::LoadPluginsFromPluginSearchPath | ( | ) |
Loads all plugins under the directories mentioned in the SearchPaths.
| void vtkPVPluginLoader::LoadPluginsFromPath | ( | const char * | path | ) |
Loads all plugin libraries at a path.
| virtual char* vtkPVPluginLoader::GetFileName | ( | ) | [virtual] |
Returns the full filename for the plugin attempted to load most recently using LoadPlugin().
| virtual char* vtkPVPluginLoader::GetPluginName | ( | ) | [virtual] |
Get the plugin name. This returns a valid name only after the plugin has been loaded.
| virtual char* vtkPVPluginLoader::GetPluginVersion | ( | ) | [virtual] |
Get the plugin version string. This returns a valid version string only after the plugin has been loaded.
| virtual char* vtkPVPluginLoader::GetErrorString | ( | ) | [virtual] |
Get the error string if the plugin failed to load. Returns NULL if the plugin was loaded successfully.
| virtual char* vtkPVPluginLoader::GetSearchPaths | ( | ) | [virtual] |
Get a string of standard search paths (path1;path2;path3) search paths are based on PV_PLUGIN_PATH, plugin dir relative to executable.
| virtual bool vtkPVPluginLoader::GetLoaded | ( | ) | [virtual] |
Returns the status of most recent LoadPlugin call.
| bool vtkPVPluginLoader::LoadPluginInternal | ( | const char * | filename, |
| bool | no_errors | ||
| ) | [protected] |
| bool vtkPVPluginLoader::LoadPlugin | ( | const char * | file, |
| vtkPVPlugin * | plugin | ||
| ) | [protected] |
Called by LoadPluginInternal() to do the final steps in loading of a plugin.
| virtual void vtkPVPluginLoader::SetErrorString | ( | const char * | ) | [protected, virtual] |
| virtual void vtkPVPluginLoader::SetPluginName | ( | const char * | ) | [protected, virtual] |
| virtual void vtkPVPluginLoader::SetPluginVersion | ( | const char * | ) | [protected, virtual] |
| virtual void vtkPVPluginLoader::SetFileName | ( | const char * | ) | [protected, virtual] |
| virtual void vtkPVPluginLoader::SetSearchPaths | ( | const char * | ) | [protected, virtual] |
Member Data Documentation
char* vtkPVPluginLoader::ErrorString [protected] |
Definition at line 111 of file vtkPVPluginLoader.h.
char* vtkPVPluginLoader::PluginName [protected] |
Definition at line 114 of file vtkPVPluginLoader.h.
char* vtkPVPluginLoader::PluginVersion [protected] |
Definition at line 115 of file vtkPVPluginLoader.h.
char* vtkPVPluginLoader::FileName [protected] |
Definition at line 116 of file vtkPVPluginLoader.h.
char* vtkPVPluginLoader::SearchPaths [protected] |
Definition at line 117 of file vtkPVPluginLoader.h.
bool vtkPVPluginLoader::DebugPlugin [protected] |
Definition at line 118 of file vtkPVPluginLoader.h.
bool vtkPVPluginLoader::Loaded [protected] |
Definition at line 119 of file vtkPVPluginLoader.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ClientServerCore/vtkPVPluginLoader.h
