vtkPVPluginsInformation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkPVPluginsInformation.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
24 #ifndef vtkPVPluginsInformation_h
25 #define vtkPVPluginsInformation_h
26 
27 #include "vtkPVInformation.h"
28 #include "vtkParaViewDeprecation.h" // needed for deprecation
29 #include "vtkRemotingCoreModule.h" // needed for exports
30 
32 {
33 public:
34  static vtkPVPluginsInformation* New();
36  void PrintSelf(ostream& os, vtkIndent indent) override;
37 
39 
42  unsigned int GetNumberOfPlugins();
43  const char* GetPluginName(unsigned int);
44  const char* GetPluginFileName(unsigned int);
45  const char* GetPluginVersion(unsigned int);
46  bool GetPluginLoaded(unsigned int);
47  const char* GetRequiredPlugins(unsigned int);
48  bool GetRequiredOnServer(unsigned int);
49  bool GetRequiredOnClient(unsigned int);
50  const char* GetDescription(unsigned int);
51  bool GetAutoLoad(unsigned int);
53 
55 
58  const char* GetPluginStatusMessage(unsigned int);
59  void SetPluginStatusMessage(unsigned int, const char*);
61 
65  void SetAutoLoad(unsigned int cc, bool);
66 
75  void SetAutoLoadAndForce(unsigned int cc, bool);
76 
80  void CopyFromObject(vtkObject*) override;
81 
85  void AddInformation(vtkPVInformation*) override;
86 
91  void Update(vtkPVPluginsInformation* other);
92 
94 
97  void CopyToStream(vtkClientServerStream*) override;
98  void CopyFromStream(const vtkClientServerStream*) override;
100 
102 
105  vtkGetStringMacro(SearchPaths);
107 
114  PARAVIEW_DEPRECATED_IN_5_11_0("Use `vtkSMProxyManager::SatisfyPluginRequirements()` instead")
115  static bool PluginRequirementsSatisfied(
116  vtkPVPluginsInformation* client_plugins, vtkPVPluginsInformation* server_plugins);
117 
118 protected:
120  ~vtkPVPluginsInformation() override;
121 
122  char* SearchPaths;
123  vtkSetStringMacro(SearchPaths);
124 
125 private:
126  vtkPVPluginsInformation(const vtkPVPluginsInformation&) = delete;
127  void operator=(const vtkPVPluginsInformation&) = delete;
128 
129  class vtkInternals;
130  vtkInternals* Internals;
131 };
132 
133 #endif
virtual void CopyFromStream(const vtkClientServerStream *)
Manage a serialized version of the information.
void PrintSelf(ostream &os, vtkIndent indent) override
virtual void Update()
Store messages for the interpreter.
information about plugins tracked by vtkPVPluginTracker.
#define VTKREMOTINGCORE_EXPORT
virtual void AddInformation(vtkPVInformation *)
Merge another information object.
virtual void CopyToStream(vtkClientServerStream *)=0
Manage a serialized version of the information.
virtual void CopyFromObject(vtkObject *)
Transfer information about a single object into this object.
#define const
Definition: zconf.h:238
static vtkObject * New()
Superclass for information objects.
#define PARAVIEW_DEPRECATED_IN_5_11_0(reason)