ParaView
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)
 
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...
 
virtual void CopyFromObject (vtkObject *)
 Transfer information about a single object into this object. More...
 
virtual void AddInformation (vtkPVInformation *)
 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...
 
bool GetAutoLoad (unsigned int)
 API to iterate over the information collected for each plugin. More...
 
virtual void CopyToStream (vtkClientServerStream *)
 Manage a serialized version of the information. More...
 
virtual void CopyFromStream (const vtkClientServerStream *)
 Manage a serialized version of the information. More...
 
virtual char * GetSearchPaths ()
 Get the plugin search path. More...
 
- Public Member Functions inherited from vtkPVInformation
void PrintSelf (ostream &os, vtkIndent indent)
 
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...
 

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)
 

Protected Member Functions

 vtkPVPluginsInformation ()
 
 ~vtkPVPluginsInformation ()
 
virtual void SetSearchPaths (const char *)
 
- Protected Member Functions inherited from vtkPVInformation
 vtkPVInformation ()
 
 ~vtkPVInformation ()
 
virtual void SetRootOnly (int)
 
 vtkPVInformation (const vtkPVInformation &) VTK_DELETE_FUNCTION
 
void operator= (const vtkPVInformation &) VTK_DELETE_FUNCTION
 

Protected Attributes

char * SearchPaths
 
- Protected Attributes inherited from vtkPVInformation
int RootOnly
 

Detailed Description

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.

Member Typedef Documentation

§ Superclass

Definition at line 34 of file vtkPVPluginsInformation.h.

Constructor & Destructor Documentation

§ vtkPVPluginsInformation()

vtkPVPluginsInformation::vtkPVPluginsInformation ( )
protected

§ ~vtkPVPluginsInformation()

vtkPVPluginsInformation::~vtkPVPluginsInformation ( )
protected

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 
)

§ 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.

§ GetAutoLoad()

bool vtkPVPluginsInformation::GetAutoLoad ( unsigned  int)

API to iterate over the information collected for each plugin.

§ GetPluginStatusMessage()

const char* vtkPVPluginsInformation::GetPluginStatusMessage ( unsigned  int)

Note that unlike other properties, this one is updated as a consequence of calling PluginRequirementsSatisfied().

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

virtual void vtkPVPluginsInformation::CopyFromObject ( vtkObject *  )
virtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

§ AddInformation()

virtual void vtkPVPluginsInformation::AddInformation ( vtkPVInformation )
virtual

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

virtual void vtkPVPluginsInformation::CopyToStream ( vtkClientServerStream )
virtual

Manage a serialized version of the information.

Implements vtkPVInformation.

§ CopyFromStream()

virtual void vtkPVPluginsInformation::CopyFromStream ( const vtkClientServerStream )
virtual

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 117 of file vtkPVPluginsInformation.h.


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