vtkPVPlugin Class Reference

defines the core interface for any ParaView plugin. More...

#include <vtkPVPlugin.h>

List of all members.

Public Member Functions
	vtkPVPlugin ()
virtual	~vtkPVPlugin ()
const char *	GetFileName ()
virtual const char *	GetPluginName ()=0
virtual const char *	GetPluginVersionString ()=0
virtual bool	GetRequiredOnServer ()=0
virtual bool	GetRequiredOnClient ()=0
virtual const char *	GetRequiredPlugins ()=0
virtual void	GetBinaryResources (std::vector< std::string > &resources)
Static Public Member Functions
static void	ImportPlugin (vtkPVPlugin *plugin)
Friends
class	vtkPVPluginLoader

---

Detailed Description

defines the core interface for any ParaView plugin.

vtkPVPlugin defines the core interface for any ParaView plugin. A plugin implementing merely this interface is pretty much useless. The header file also defines few import macros that are required for exporting/importing plugins.

When debugging issues with plugins try setting the PV_PLUGIN_DEBUG environment variable on all the processes where you are trying to load the plugin. That will print extra information as the plugin is being loaded.

Definition at line 45 of file vtkPVPlugin.h.

---

Constructor & Destructor Documentation

vtkPVPlugin::vtkPVPlugin

(

)

virtual vtkPVPlugin::~vtkPVPlugin

(

)

[virtual]

---

Member Function Documentation

const char* vtkPVPlugin::GetFileName

(

)

[inline]

Definition at line 54 of file vtkPVPlugin.h.

virtual const char* vtkPVPlugin::GetPluginName

(

)

[pure virtual]

Returns the name for this plugin.

virtual const char* vtkPVPlugin::GetPluginVersionString

(

)

[pure virtual]

Returns the version for this plugin.

virtual bool vtkPVPlugin::GetRequiredOnServer

(

)

[pure virtual]

Returns true if this plugin is required on the server.

virtual bool vtkPVPlugin::GetRequiredOnClient

(

)

[pure virtual]

Returns true if this plugin is required on the client.

virtual const char* vtkPVPlugin::GetRequiredPlugins

(

)

[pure virtual]

Returns a ';' separated list of plugin names required by this plugin.

virtual void vtkPVPlugin::GetBinaryResources

(

std::vector< std::string > &

resources

)

[virtual]

Provides access to binary resources compiled into the plugin. This is primarily used to compile in icons and compressed help project (qch) files into plugins.

static void vtkPVPlugin::ImportPlugin

(

vtkPVPlugin *

plugin

)

[static]

Used when import plugins programmatically. This must only be called after the application has initialized, more specifically, all plugin managers have been created and they have registered their callbacks.

---

Friends And Related Function Documentation

friend class vtkPVPluginLoader [friend]

Definition at line 49 of file vtkPVPlugin.h.

---

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

• dox/ParaViewCore/ClientServerCore/vtkPVPlugin.h