vtkSMPluginManager Class Reference

manages ParaView plugins. More...

#include <vtkSMPluginManager.h>

Inheritance diagram for vtkSMPluginManager:

Collaboration diagram for vtkSMPluginManager:

List of all members.

Public Types
enum	{ PluginLoadedEvent = 100000 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	RegisterSession (vtkSMSession *)
void	UnRegisterSession (vtkSMSession *)
virtual vtkPVPluginsInformation *	GetLocalInformation ()
vtkPVPluginsInformation *	GetRemoteInformation (vtkSMSession *)
const char *	GetLocalPluginSearchPaths ()
const char *	GetRemotePluginSearchPaths (vtkSMSession *)
bool	LoadRemotePlugin (const char *filename, vtkSMSession *)
bool	LoadLocalPlugin (const char *filename)
void	LoadPluginConfigurationXMLFromString (const char *xmlcontents, vtkSMSession *session, bool remote)
Static Public Member Functions
static vtkSMPluginManager *	New ()
static int	IsTypeOf (const char *type)
static vtkSMPluginManager *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMPluginManager ()
	~vtkSMPluginManager ()
Protected Attributes
vtkPVPluginsInformation *	LocalInformation

---

Detailed Description

manages ParaView plugins.

vtkSMPluginManager is used to load plugins as well as discover information about currently loaded and available plugins.

vtkSMPluginManager supports multiple sessions. Every vtkSMSession registers itself with the vtkSMPluginManager during initialization.

Definition at line 33 of file vtkSMPluginManager.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

PluginLoadedEvent

Definition at line 87 of file vtkSMPluginManager.h.

---

Constructor & Destructor Documentation

vtkSMPluginManager::vtkSMPluginManager

(

)

[protected]

vtkSMPluginManager::~vtkSMPluginManager

(

)

[protected]

---

Member Function Documentation

static vtkSMPluginManager* vtkSMPluginManager::New

(

)

[static]

Reimplemented from vtkSMObject.

virtual const char* vtkSMPluginManager::GetClassName

(

)

[virtual]

Reimplemented from vtkSMObject.

static int vtkSMPluginManager::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMObject.

virtual int vtkSMPluginManager::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMObject.

static vtkSMPluginManager* vtkSMPluginManager::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMObject.

void vtkSMPluginManager::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Reimplemented from vtkSMObject.

void vtkSMPluginManager::RegisterSession

(

vtkSMSession *

)

Register/Unregister a session. Every vtkSMSession must be registered with the vtkSMPluginManager. This is done automatically by vtkSMSession during the initialization stage. Note that the vtkSMSession is not reference counted.

void vtkSMPluginManager::UnRegisterSession

(

vtkSMSession *

)

Register/Unregister a session. Every vtkSMSession must be registered with the vtkSMPluginManager. This is done automatically by vtkSMSession during the initialization stage. Note that the vtkSMSession is not reference counted.

virtual vtkPVPluginsInformation* vtkSMPluginManager::GetLocalInformation

(

)

[virtual]

vtkPVPluginsInformation provides information about plugins loaded/available. LocalInformation corresponds to plugins loaded on the local process. For remote sessions i.e. those that connect to a remote server process, one can use GetRemoteInformation() to access information about plugins on the remote process.

vtkPVPluginsInformation* vtkSMPluginManager::GetRemoteInformation

(

vtkSMSession *

)

vtkPVPluginsInformation provides information about plugins loaded/available. LocalInformation corresponds to plugins loaded on the local process. For remote sessions i.e. those that connect to a remote server process, one can use GetRemoteInformation() to access information about plugins on the remote process.

const char* vtkSMPluginManager::GetLocalPluginSearchPaths

(

)

Returns the plugin search paths used either locally or remotely. For non-remote sessions, GetRemotePluginSearchPaths() returns the same value as GetLocalPluginSearchPaths().

const char* vtkSMPluginManager::GetRemotePluginSearchPaths

(

vtkSMSession *

)

Returns the plugin search paths used either locally or remotely. For non-remote sessions, GetRemotePluginSearchPaths() returns the same value as GetLocalPluginSearchPaths().

bool vtkSMPluginManager::LoadRemotePlugin	(	const char *	filename,
		vtkSMSession *
	)

Loads the plugin either locally or remotely.

bool vtkSMPluginManager::LoadLocalPlugin

(

const char *

filename

)

Loads the plugin either locally or remotely.

void vtkSMPluginManager::LoadPluginConfigurationXMLFromString	(	const char *	xmlcontents,
		vtkSMSession *	session,
		bool	remote
	)

Plugin configuration XML is a simple XML that makes ParaView aware of the plugins available and may result in loading of those plugins that are marked for auto-loading. In ParaView application there are two uses for this:

• .plugins - used to notify ParaView of the distributed plugins
• session - used to save/restore the plugins loaded by the users. This method loads the plugin configuration xml either on the local process or the remote server process(es). session is only used when remote==true and session itself is a remote session.

---

Member Data Documentation

vtkPVPluginsInformation* vtkSMPluginManager::LocalInformation [protected]

Definition at line 96 of file vtkSMPluginManager.h.

---

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

• dox/ParaViewCore/ServerManager/vtkSMPluginManager.h