information about plugins tracked by vtkPVPluginTracker. More...
#include <vtkPVPluginsInformation.h>
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 |
const char * | GetPluginStatusMessage (unsigned int) |
Note that unlike other properties, this one is updated as a consequence of calling PluginRequirementsSatisfied(). More... | |
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... | |
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) |
vtkCommand * | GetCommand (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) |
vtkCommand * | GetCommand (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 vtkPVPluginsInformation * | New () |
static int | IsTypeOf (const char *type) |
static vtkPVPluginsInformation * | SafeDownCast (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 vtkPVInformation * | SafeDownCast (vtkObject *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
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 vtkObjectBase * | New () |
static vtkObjectBase * | New () |
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 |
information about plugins tracked by vtkPVPluginTracker.
vtkPVPluginsInformation is used to collect information about plugins tracked by vtkPVPluginTracker.
Definition at line 30 of file vtkPVPluginsInformation.h.
Definition at line 34 of file vtkPVPluginsInformation.h.
|
protected |
|
overrideprotected |
|
static |
|
virtual |
Reimplemented from vtkPVInformation.
|
static |
|
virtual |
Reimplemented from vtkPVInformation.
|
static |
|
overridevirtual |
Reimplemented from vtkPVInformation.
unsigned int vtkPVPluginsInformation::GetNumberOfPlugins | ( | ) |
API to iterate over the information collected for each plugin.
const char* vtkPVPluginsInformation::GetPluginName | ( | unsigned int | ) |
API to iterate over the information collected for each plugin.
const char* vtkPVPluginsInformation::GetPluginFileName | ( | unsigned int | ) |
API to iterate over the information collected for each plugin.
const char* vtkPVPluginsInformation::GetPluginVersion | ( | unsigned int | ) |
API to iterate over the information collected for each plugin.
bool vtkPVPluginsInformation::GetPluginLoaded | ( | unsigned int | ) |
API to iterate over the information collected for each plugin.
const char* vtkPVPluginsInformation::GetRequiredPlugins | ( | unsigned int | ) |
API to iterate over the information collected for each plugin.
bool vtkPVPluginsInformation::GetRequiredOnServer | ( | unsigned int | ) |
API to iterate over the information collected for each plugin.
bool vtkPVPluginsInformation::GetRequiredOnClient | ( | unsigned int | ) |
API to iterate over the information collected for each plugin.
const char* vtkPVPluginsInformation::GetDescription | ( | unsigned int | ) |
API to iterate over the information collected for each plugin.
bool vtkPVPluginsInformation::GetAutoLoad | ( | unsigned int | ) |
API to iterate over the information collected for each plugin.
const char* vtkPVPluginsInformation::GetPluginStatusMessage | ( | unsigned int | ) |
Note that unlike other properties, this one is updated as a consequence of calling PluginRequirementsSatisfied().
void vtkPVPluginsInformation::SetAutoLoad | ( | unsigned int | cc, |
bool | |||
) |
API to change auto-load status.
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.
|
overridevirtual |
Transfer information about a single object into this object.
Reimplemented from vtkPVInformation.
|
overridevirtual |
Merge another information object.
Reimplemented from vtkPVInformation.
void vtkPVPluginsInformation::Update | ( | vtkPVPluginsInformation * | other | ) |
Updates the local information with elements from other without overriding auto-load state.
|
overridevirtual |
Manage a serialized version of the information.
Implements vtkPVInformation.
|
overridevirtual |
Manage a serialized version of the information.
Reimplemented from vtkPVInformation.
|
virtual |
Get the plugin search path.
|
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.
|
protectedvirtual |
|
protected |
Definition at line 118 of file vtkPVPluginsInformation.h.