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

manages ParaView plugins. More...

#include <vtkSMPluginManager.h>

Inheritance diagram for vtkSMPluginManager:
Inheritance graph
[legend]
Collaboration diagram for vtkSMPluginManager:
Collaboration graph
[legend]

Public Types

enum  { PluginLoadedEvent = 100000, LocalPluginLoadedEvent, RemotePluginLoadedEvent }
 
typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void 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. More...
 
bool FulfillPluginRequirements (vtkSMSession *session, bool onlyCheck=false)
 Method to load remote plugins in order to meet plugin requirement across processes. More...
 
void RegisterSession (vtkSMSession *)
 Register/Unregister a session. More...
 
void UnRegisterSession (vtkSMSession *)
 Register/Unregister a session. More...
 
virtual vtkPVPluginsInformationGetLocalInformation ()
 vtkPVPluginsInformation provides information about plugins loaded/available. More...
 
vtkPVPluginsInformationGetRemoteInformation (vtkSMSession *)
 vtkPVPluginsInformation provides information about plugins loaded/available. More...
 
const char * GetLocalPluginSearchPaths ()
 Returns the plugin search paths used either locally or remotely. More...
 
const char * GetRemotePluginSearchPaths (vtkSMSession *)
 Returns the plugin search paths used either locally or remotely. More...
 
bool LoadRemotePlugin (const char *filename, vtkSMSession *)
 Loads the plugin either locally or remotely. More...
 
bool LoadLocalPlugin (const char *filename)
 Loads the plugin either locally or remotely. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSMPluginManagerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMPluginManagerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMPluginManager ()
 
 ~vtkSMPluginManager () override
 
void OnPluginRegistered ()
 
void OnPluginAvailable ()
 
void UpdateLocalPluginInformation ()
 
bool FulfillPluginClientServerRequirements (vtkSMSession *session, const std::map< std::string, unsigned int > &inputMap, vtkPVPluginsInformation *inputPluginInfo, const std::map< std::string, unsigned int > &outputMap, vtkPVPluginsInformation *outputPluginInfo, bool inputClient, bool onlyCheck)
 Protected method used by FulfillPluginRequirements to check and load client/server plugin requirements. More...
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

bool InLoadPlugin
 
vtkPVPluginsInformationLocalInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 35 of file vtkSMPluginManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkSMPluginManager.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
PluginLoadedEvent 
LocalPluginLoadedEvent 
RemotePluginLoadedEvent 

Definition at line 106 of file vtkSMPluginManager.h.

Constructor & Destructor Documentation

◆ vtkSMPluginManager()

vtkSMPluginManager::vtkSMPluginManager ( )
protected

◆ ~vtkSMPluginManager()

vtkSMPluginManager::~vtkSMPluginManager ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMPluginManager* vtkSMPluginManager::New ( )
static

◆ GetClassName()

virtual const char* vtkSMPluginManager::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMObject.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSMPluginManager::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkSMObject.

◆ RegisterSession()

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.

◆ UnRegisterSession()

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.

◆ GetLocalInformation()

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.

◆ GetRemoteInformation()

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.

◆ GetLocalPluginSearchPaths()

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().

◆ GetRemotePluginSearchPaths()

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().

◆ LoadRemotePlugin()

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

Loads the plugin either locally or remotely.

◆ LoadLocalPlugin()

bool vtkSMPluginManager::LoadLocalPlugin ( const char *  filename)

Loads the plugin either locally or remotely.

◆ LoadPluginConfigurationXMLFromString()

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.

◆ FulfillPluginRequirements()

bool vtkSMPluginManager::FulfillPluginRequirements ( vtkSMSession session,
bool  onlyCheck = false 
)

Method to load remote plugins in order to meet plugin requirement across processes.

This also updates the "StatusMessage" for all the plugins. If StatusMessage is empty for a loaded plugin, it implies that everything is fine. If some requirement is not met, the StatusMessage includes the error message. Set onlyCheck to true to only check and set status without loading plugins.

◆ OnPluginRegistered()

void vtkSMPluginManager::OnPluginRegistered ( )
protected

◆ OnPluginAvailable()

void vtkSMPluginManager::OnPluginAvailable ( )
protected

◆ UpdateLocalPluginInformation()

void vtkSMPluginManager::UpdateLocalPluginInformation ( )
protected

◆ FulfillPluginClientServerRequirements()

bool vtkSMPluginManager::FulfillPluginClientServerRequirements ( vtkSMSession session,
const std::map< std::string, unsigned int > &  inputMap,
vtkPVPluginsInformation inputPluginInfo,
const std::map< std::string, unsigned int > &  outputMap,
vtkPVPluginsInformation outputPluginInfo,
bool  inputClient,
bool  onlyCheck 
)
protected

Protected method used by FulfillPluginRequirements to check and load client/server plugin requirements.

Member Data Documentation

◆ InLoadPlugin

bool vtkSMPluginManager::InLoadPlugin
protected

Definition at line 117 of file vtkSMPluginManager.h.

◆ LocalInformation

vtkPVPluginsInformation* vtkSMPluginManager::LocalInformation
protected

Definition at line 131 of file vtkSMPluginManager.h.


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