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

information about plugins tracked by vtkPVPluginTracker. More...

#include <vtkPVPluginsInformation.h>

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

Public Types

typedef vtkPVInformation Superclass
 
- Public Types inherited from vtkPVInformation
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetAutoLoad (unsigned int cc, bool)
 API to change auto-load status. More...
 
void SetAutoLoadAndForce (unsigned int cc, bool)
 This is a hack. More...
 
void CopyFromObject (vtkObject *) override
 Transfer information about a single object into this object. More...
 
void AddInformation (vtkPVInformation *) override
 Merge another information object. More...
 
void Update (vtkPVPluginsInformation *other)
 Updates the local information with elements from other without overriding auto-load state. More...
 
unsigned int GetNumberOfPlugins ()
 API to iterate over the information collected for each plugin. More...
 
const char * GetPluginName (unsigned int)
 API to iterate over the information collected for each plugin. More...
 
const char * GetPluginFileName (unsigned int)
 API to iterate over the information collected for each plugin. More...
 
const char * GetPluginVersion (unsigned int)
 API to iterate over the information collected for each plugin. More...
 
bool GetPluginLoaded (unsigned int)
 API to iterate over the information collected for each plugin. More...
 
const char * GetRequiredPlugins (unsigned int)
 API to iterate over the information collected for each plugin. More...
 
bool GetRequiredOnServer (unsigned int)
 API to iterate over the information collected for each plugin. More...
 
bool GetRequiredOnClient (unsigned int)
 API to iterate over the information collected for each plugin. More...
 
const char * GetDescription (unsigned int)
 API to iterate over the information collected for each plugin. More...
 
bool GetAutoLoad (unsigned int)
 API to iterate over the information collected for each plugin. More...
 
const char * GetPluginStatusMessage (unsigned int)
 Set/Get the plugin status message for a specific plugin. More...
 
void SetPluginStatusMessage (unsigned int, const char *)
 Set/Get the plugin status message for a specific plugin. More...
 
void CopyToStream (vtkClientServerStream *) override
 Manage a serialized version of the information. More...
 
void CopyFromStream (const vtkClientServerStream *) override
 Manage a serialized version of the information. More...
 
virtual char * GetSearchPaths ()
 Get the plugin search path. More...
 
- Public Member Functions inherited from vtkPVInformation
virtual void CopyParametersToStream (vtkMultiProcessStream &)
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual void CopyParametersFromStream (vtkMultiProcessStream &)
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual int GetRootOnly ()
 Set/get whether to gather information only from the root. 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 vtkPVPluginsInformationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVPluginsInformationSafeDownCast (vtkObject *o)
 
static bool PluginRequirementsSatisfied (vtkPVPluginsInformation *client_plugins, vtkPVPluginsInformation *server_plugins)
 Method to validate if the plugin requirements are met across processes. More...
 
- Static Public Member Functions inherited from vtkPVInformation
static int IsTypeOf (const char *type)
 
static vtkPVInformationSafeDownCast (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

 vtkPVPluginsInformation ()
 
 ~vtkPVPluginsInformation () override
 
virtual void SetSearchPaths (const char *)
 
- Protected Member Functions inherited from vtkPVInformation
 vtkPVInformation ()
 
 ~vtkPVInformation () override
 
virtual void SetRootOnly (int)
 
 vtkPVInformation (const vtkPVInformation &)=delete
 
void operator= (const vtkPVInformation &)=delete
 
- 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

char * SearchPaths
 
- Protected Attributes inherited from vtkPVInformation
int RootOnly
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

information about plugins tracked by vtkPVPluginTracker.

vtkPVPluginsInformation is used to collect information about plugins tracked by vtkPVPluginTracker.

Definition at line 31 of file vtkPVPluginsInformation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 35 of file vtkPVPluginsInformation.h.

Constructor & Destructor Documentation

◆ vtkPVPluginsInformation()

vtkPVPluginsInformation::vtkPVPluginsInformation ( )
protected

◆ ~vtkPVPluginsInformation()

vtkPVPluginsInformation::~vtkPVPluginsInformation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPVPluginsInformation* vtkPVPluginsInformation::New ( )
static

◆ GetClassName()

virtual const char* vtkPVPluginsInformation::GetClassName ( )
virtual

Reimplemented from vtkPVInformation.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVInformation.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkPVInformation.

◆ GetNumberOfPlugins()

unsigned int vtkPVPluginsInformation::GetNumberOfPlugins ( )

API to iterate over the information collected for each plugin.

◆ GetPluginName()

const char* vtkPVPluginsInformation::GetPluginName ( unsigned  int)

API to iterate over the information collected for each plugin.

◆ GetPluginFileName()

const char* vtkPVPluginsInformation::GetPluginFileName ( unsigned  int)

API to iterate over the information collected for each plugin.

◆ GetPluginVersion()

const char* vtkPVPluginsInformation::GetPluginVersion ( unsigned  int)

API to iterate over the information collected for each plugin.

◆ GetPluginLoaded()

bool vtkPVPluginsInformation::GetPluginLoaded ( unsigned  int)

API to iterate over the information collected for each plugin.

◆ GetRequiredPlugins()

const char* vtkPVPluginsInformation::GetRequiredPlugins ( unsigned  int)

API to iterate over the information collected for each plugin.

◆ GetRequiredOnServer()

bool vtkPVPluginsInformation::GetRequiredOnServer ( unsigned  int)

API to iterate over the information collected for each plugin.

◆ GetRequiredOnClient()

bool vtkPVPluginsInformation::GetRequiredOnClient ( unsigned  int)

API to iterate over the information collected for each plugin.

◆ GetDescription()

const char* vtkPVPluginsInformation::GetDescription ( unsigned  int)

API to iterate over the information collected for each plugin.

◆ GetAutoLoad()

bool vtkPVPluginsInformation::GetAutoLoad ( unsigned  int)

API to iterate over the information collected for each plugin.

◆ GetPluginStatusMessage()

const char* vtkPVPluginsInformation::GetPluginStatusMessage ( unsigned  int)

Set/Get the plugin status message for a specific plugin.

◆ SetPluginStatusMessage()

void vtkPVPluginsInformation::SetPluginStatusMessage ( unsigned  int,
const char *   
)

Set/Get the plugin status message for a specific plugin.

◆ SetAutoLoad()

void vtkPVPluginsInformation::SetAutoLoad ( unsigned int  cc,
bool   
)

API to change auto-load status.

◆ SetAutoLoadAndForce()

void vtkPVPluginsInformation::SetAutoLoadAndForce ( unsigned int  cc,
bool   
)

This is a hack.

When the user sets an auto-load option from the GUI to avoid that choice being overwritten as the information object is updated over time as new plugins are loaded/unloaded, the pqPluginDialog uses this method to set the auto-load flag. This flag is not communicated across processes, but when called, GetAutoLoad() will return the value set using this method.

◆ CopyFromObject()

void vtkPVPluginsInformation::CopyFromObject ( vtkObject )
overridevirtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

◆ AddInformation()

void vtkPVPluginsInformation::AddInformation ( vtkPVInformation )
overridevirtual

Merge another information object.

Reimplemented from vtkPVInformation.

◆ Update()

void vtkPVPluginsInformation::Update ( vtkPVPluginsInformation other)

Updates the local information with elements from other without overriding auto-load state.

◆ CopyToStream()

void vtkPVPluginsInformation::CopyToStream ( vtkClientServerStream )
overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

◆ CopyFromStream()

void vtkPVPluginsInformation::CopyFromStream ( const vtkClientServerStream )
overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

◆ GetSearchPaths()

virtual char* vtkPVPluginsInformation::GetSearchPaths ( )
virtual

Get the plugin search path.

◆ PluginRequirementsSatisfied()

static bool vtkPVPluginsInformation::PluginRequirementsSatisfied ( vtkPVPluginsInformation client_plugins,
vtkPVPluginsInformation server_plugins 
)
static

Method to validate if the plugin requirements are met across processes.

This also updated 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.

◆ SetSearchPaths()

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

Member Data Documentation

◆ SearchPaths

char* vtkPVPluginsInformation::SearchPaths
protected

Definition at line 122 of file vtkPVPluginsInformation.h.


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