information about plugins tracked by vtkPVPluginTracker. More...
#include <vtkPVPluginsInformation.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| const char * | GetPluginStatusMessage (unsigned int) |
| void | SetAutoLoad (unsigned int cc, bool) |
| void | SetAutoLoadAndForce (unsigned int cc, bool) |
| virtual void | CopyFromObject (vtkObject *) |
| virtual void | AddInformation (vtkPVInformation *) |
| void | Update (vtkPVPluginsInformation *other) |
| unsigned int | GetNumberOfPlugins () |
| const char * | GetPluginName (unsigned int) |
| const char * | GetPluginFileName (unsigned int) |
| const char * | GetPluginVersion (unsigned int) |
| bool | GetPluginLoaded (unsigned int) |
| const char * | GetRequiredPlugins (unsigned int) |
| bool | GetRequiredOnServer (unsigned int) |
| bool | GetRequiredOnClient (unsigned int) |
| bool | GetAutoLoad (unsigned int) |
| virtual void | CopyToStream (vtkClientServerStream *) |
| virtual void | CopyFromStream (const vtkClientServerStream *) |
| virtual char * | GetSearchPaths () |
Static Public Member Functions | |
| static vtkPVPluginsInformation * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkPVPluginsInformation * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| virtual void | SetSearchPaths (const char *) |
Protected Attributes | |
| char * | SearchPaths |
| static bool | PluginRequirementsSatisfied (vtkPVPluginsInformation *client_plugins, vtkPVPluginsInformation *server_plugins) |
| vtkPVPluginsInformation () | |
| ~vtkPVPluginsInformation () | |
Detailed Description
information about plugins tracked by vtkPVPluginTracker.
vtkPVPluginsInformation is used to collect information about plugins tracked by vtkPVPluginTracker.
Definition at line 28 of file vtkPVPluginsInformation.h.
Constructor & Destructor Documentation
| vtkPVPluginsInformation::vtkPVPluginsInformation | ( | ) | [protected] |
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.
| vtkPVPluginsInformation::~vtkPVPluginsInformation | ( | ) | [protected] |
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.
Member Function Documentation
| static vtkPVPluginsInformation* vtkPVPluginsInformation::New | ( | ) | [static] |
Reimplemented from vtkObject.
| virtual const char* vtkPVPluginsInformation::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkPVInformation.
| static int vtkPVPluginsInformation::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkPVInformation.
| virtual int vtkPVPluginsInformation::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkPVInformation.
| static vtkPVPluginsInformation* vtkPVPluginsInformation::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkPVInformation.
| void vtkPVPluginsInformation::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
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.
| 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.
| virtual void vtkPVPluginsInformation::CopyFromObject | ( | vtkObject * | ) | [virtual] |
Transfer information about a single object into this object.
Reimplemented from vtkPVInformation.
| virtual void vtkPVPluginsInformation::AddInformation | ( | vtkPVInformation * | ) | [virtual] |
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.
| virtual void vtkPVPluginsInformation::CopyToStream | ( | vtkClientServerStream * | ) | [virtual] |
Manage a serialized version of the information.
Implements vtkPVInformation.
| virtual void vtkPVPluginsInformation::CopyFromStream | ( | const vtkClientServerStream * | ) | [virtual] |
Manage a serialized version of the information.
Reimplemented from vtkPVInformation.
| virtual char* vtkPVPluginsInformation::GetSearchPaths | ( | ) | [virtual] |
Get the plugin search path.
| 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.
| virtual void vtkPVPluginsInformation::SetSearchPaths | ( | const char * | ) | [protected, virtual] |
Member Data Documentation
char* vtkPVPluginsInformation::SearchPaths [protected] |
Definition at line 101 of file vtkPVPluginsInformation.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ClientServerCore/vtkPVPluginsInformation.h
