1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*=========================================================================
Program: ParaView
Module: vtkPVPluginsInformation.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkPVPluginsInformation
* @brief information about plugins tracked by
* vtkPVPluginTracker.
*
* vtkPVPluginsInformation is used to collect information about plugins tracked
* by vtkPVPluginTracker.
*/
#ifndef vtkPVPluginsInformation_h
#define vtkPVPluginsInformation_h
#include "vtkPVClientServerCoreCoreModule.h" //needed for exports
#include "vtkPVInformation.h"
class VTKPVCLIENTSERVERCORECORE_EXPORT vtkPVPluginsInformation : public vtkPVInformation
{
public:
static vtkPVPluginsInformation* New();
vtkTypeMacro(vtkPVPluginsInformation, vtkPVInformation);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@{
/**
* API to iterate over the information collected for each plugin.
*/
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);
//@}
/**
* Note that unlike other properties, this one is updated as a consequence of
* calling PluginRequirementsSatisfied().
*/
const char* GetPluginStatusMessage(unsigned int);
/**
* API to change auto-load status.
*/
void SetAutoLoad(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.
*/
void SetAutoLoadAndForce(unsigned int cc, bool);
/**
* Transfer information about a single object into this object.
*/
virtual void CopyFromObject(vtkObject*) VTK_OVERRIDE;
/**
* Merge another information object.
*/
virtual void AddInformation(vtkPVInformation*) VTK_OVERRIDE;
/**
* Updates the local information with elements from other without overriding
* auto-load state.
*/
void Update(vtkPVPluginsInformation* other);
//@{
/**
* Manage a serialized version of the information.
*/
virtual void CopyToStream(vtkClientServerStream*) VTK_OVERRIDE;
virtual void CopyFromStream(const vtkClientServerStream*) VTK_OVERRIDE;
//@}
//@{
/**
* Get the plugin search path.
*/
vtkGetStringMacro(SearchPaths);
//@}
/**
* 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.
*/
static bool PluginRequirementsSatisfied(
vtkPVPluginsInformation* client_plugins, vtkPVPluginsInformation* server_plugins);
protected:
vtkPVPluginsInformation();
~vtkPVPluginsInformation();
char* SearchPaths;
vtkSetStringMacro(SearchPaths);
private:
vtkPVPluginsInformation(const vtkPVPluginsInformation&) VTK_DELETE_FUNCTION;
void operator=(const vtkPVPluginsInformation&) VTK_DELETE_FUNCTION;
class vtkInternals;
vtkInternals* Internals;
};
#endif
|
