ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVPluginLoader Class Reference

Used to load ParaView plugins. More...

#include <vtkPVPluginLoader.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
bool LoadPlugin (const char *filename)
 Tries to the load the plugin given the path to the plugin file. More...
 
bool LoadPluginSilently (const char *filename)
 
void LoadPluginConfigurationXMLFromString (const char *xmlcontents)
 Simply forwards the call to vtkPVPluginLoader::LoadPluginConfigurationXMLFromString to load configuration xml. More...
 
void LoadPluginsFromPluginSearchPath ()
 Loads all plugins under the directories mentioned in the SearchPaths. More...
 
void LoadPluginsFromPluginConfigFile ()
 Use PV_PLUGIN_CONFILE_FILE xml file to load specified plugins It can contain path to multiples xml pluginc config files sperated by env separator. More...
 
void LoadPluginsFromPath (const char *path)
 Loads all plugin libraries at a path. More...
 
virtual char * GetFileName ()
 Returns the full filename for the plugin attempted to load most recently using LoadPlugin(). More...
 
virtual char * GetPluginName ()
 Get the plugin name. More...
 
virtual char * GetPluginVersion ()
 Get the plugin version string. More...
 
virtual char * GetErrorString ()
 Get the error string if the plugin failed to load. More...
 
virtual char * GetSearchPaths ()
 Get a string of standard search paths (path1;path2;path3) search paths are based on PV_PLUGIN_PATH, plugin dir relative to executable. More...
 
virtual bool GetLoaded ()
 Returns the status of most recent LoadPlugin call. More...
 

Static Public Member Functions

static vtkPVPluginLoaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVPluginLoaderSafeDownCast (vtkObject *o)
 
static void SetStaticPluginLoadFunction (vtkPluginLoadFunction function)
 Sets the function used to load static plugins. More...
 
static void PluginLibraryUnloaded (const char *pluginname)
 Internal method used in pqParaViewPlugin.cxx.in to tell the vtkPVPluginLoader that a library was unloaded so it doesn't try to unload it again. More...
 

Protected Member Functions

 vtkPVPluginLoader ()
 
 ~vtkPVPluginLoader ()
 
bool LoadPluginInternal (const char *filename, bool no_errors)
 
bool LoadPlugin (const char *file, vtkPVPlugin *plugin)
 Called by LoadPluginInternal() to do the final steps in loading of a plugin. More...
 
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 40 of file vtkPVPluginLoader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVPluginLoader::Superclass

Definition at line 44 of file vtkPVPluginLoader.h.

Constructor & Destructor Documentation

◆ vtkPVPluginLoader()

vtkPVPluginLoader::vtkPVPluginLoader ( )
protected

◆ ~vtkPVPluginLoader()

vtkPVPluginLoader::~vtkPVPluginLoader ( )
protected

Member Function Documentation

◆ New()

static vtkPVPluginLoader* vtkPVPluginLoader::New ( )
static

◆ GetClassName()

virtual const char* vtkPVPluginLoader::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkPVPluginLoader::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPVPluginLoader::IsA ( const char *  type)
virtual

◆ SafeDownCast()

static vtkPVPluginLoader* vtkPVPluginLoader::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

void vtkPVPluginLoader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ LoadPlugin() [1/2]

bool vtkPVPluginLoader::LoadPlugin ( const char *  filename)
inline

Tries to the load the plugin given the path to the plugin file.

Definition at line 50 of file vtkPVPluginLoader.h.

◆ LoadPluginSilently()

bool vtkPVPluginLoader::LoadPluginSilently ( const char *  filename)
inline

Definition at line 51 of file vtkPVPluginLoader.h.

◆ LoadPluginConfigurationXMLFromString()

void vtkPVPluginLoader::LoadPluginConfigurationXMLFromString ( const char *  xmlcontents)

Simply forwards the call to vtkPVPluginLoader::LoadPluginConfigurationXMLFromString to load configuration xml.

◆ LoadPluginsFromPluginSearchPath()

void vtkPVPluginLoader::LoadPluginsFromPluginSearchPath ( )

Loads all plugins under the directories mentioned in the SearchPaths.

◆ LoadPluginsFromPluginConfigFile()

void vtkPVPluginLoader::LoadPluginsFromPluginConfigFile ( )

Use PV_PLUGIN_CONFILE_FILE xml file to load specified plugins It can contain path to multiples xml pluginc config files sperated by env separator.

It allow user to fine pick which plugins to load, instead of using PV_PLUGIN_PATH the format a xml plugin file should be the following : <?xml version="1.0"?> <Plugins> <Plugin name="MyPlugin" filename="absolute/path/to/libMyPlugin.so"> ... </Plugins>

◆ LoadPluginsFromPath()

void vtkPVPluginLoader::LoadPluginsFromPath ( const char *  path)

Loads all plugin libraries at a path.

◆ GetFileName()

virtual char* vtkPVPluginLoader::GetFileName ( )
virtual

Returns the full filename for the plugin attempted to load most recently using LoadPlugin().

◆ GetPluginName()

virtual char* vtkPVPluginLoader::GetPluginName ( )
virtual

Get the plugin name.

This returns a valid name only after the plugin has been loaded.

◆ GetPluginVersion()

virtual char* vtkPVPluginLoader::GetPluginVersion ( )
virtual

Get the plugin version string.

This returns a valid version string only after the plugin has been loaded.

◆ GetErrorString()

virtual char* vtkPVPluginLoader::GetErrorString ( )
virtual

Get the error string if the plugin failed to load.

Returns NULL if the plugin was loaded successfully.

◆ GetSearchPaths()

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.

◆ GetLoaded()

virtual bool vtkPVPluginLoader::GetLoaded ( )
virtual

Returns the status of most recent LoadPlugin call.

◆ SetStaticPluginLoadFunction()

static void vtkPVPluginLoader::SetStaticPluginLoadFunction ( vtkPluginLoadFunction  function)
static

Sets the function used to load static plugins.

◆ PluginLibraryUnloaded()

static void vtkPVPluginLoader::PluginLibraryUnloaded ( const char *  pluginname)
static

Internal method used in pqParaViewPlugin.cxx.in to tell the vtkPVPluginLoader that a library was unloaded so it doesn't try to unload it again.

◆ LoadPluginInternal()

bool vtkPVPluginLoader::LoadPluginInternal ( const char *  filename,
bool  no_errors 
)
protected

◆ LoadPlugin() [2/2]

bool vtkPVPluginLoader::LoadPlugin ( const char *  file,
vtkPVPlugin plugin 
)
protected

Called by LoadPluginInternal() to do the final steps in loading of a plugin.

◆ SetErrorString()

virtual void vtkPVPluginLoader::SetErrorString ( const char *  )
protectedvirtual

◆ SetPluginName()

virtual void vtkPVPluginLoader::SetPluginName ( const char *  )
protectedvirtual

◆ SetPluginVersion()

virtual void vtkPVPluginLoader::SetPluginVersion ( const char *  )
protectedvirtual

◆ SetFileName()

virtual void vtkPVPluginLoader::SetFileName ( const char *  )
protectedvirtual

◆ SetSearchPaths()

virtual void vtkPVPluginLoader::SetSearchPaths ( const char *  )
protectedvirtual

Member Data Documentation

◆ ErrorString

char* vtkPVPluginLoader::ErrorString
protected

Definition at line 160 of file vtkPVPluginLoader.h.

◆ PluginName

char* vtkPVPluginLoader::PluginName
protected

Definition at line 163 of file vtkPVPluginLoader.h.

◆ PluginVersion

char* vtkPVPluginLoader::PluginVersion
protected

Definition at line 164 of file vtkPVPluginLoader.h.

◆ FileName

char* vtkPVPluginLoader::FileName
protected

Definition at line 165 of file vtkPVPluginLoader.h.

◆ SearchPaths

char* vtkPVPluginLoader::SearchPaths
protected

Definition at line 166 of file vtkPVPluginLoader.h.

◆ DebugPlugin

bool vtkPVPluginLoader::DebugPlugin
protected

Definition at line 167 of file vtkPVPluginLoader.h.

◆ Loaded

bool vtkPVPluginLoader::Loaded
protected

Definition at line 168 of file vtkPVPluginLoader.h.


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