ParaView
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 "vtkPVClientServerCoreCoreModule.h" //needed for exports
28 #include "vtkPVInformation.h"
29 
30 class VTKPVCLIENTSERVERCORECORE_EXPORT vtkPVPluginsInformation : public vtkPVInformation
31 {
32 public:
33  static vtkPVPluginsInformation* New();
35  void PrintSelf(ostream& os, vtkIndent indent);
36 
38 
41  unsigned int GetNumberOfPlugins();
42  const char* GetPluginName(unsigned int);
43  const char* GetPluginFileName(unsigned int);
44  const char* GetPluginVersion(unsigned int);
45  bool GetPluginLoaded(unsigned int);
46  const char* GetRequiredPlugins(unsigned int);
47  bool GetRequiredOnServer(unsigned int);
48  bool GetRequiredOnClient(unsigned int);
49  bool GetAutoLoad(unsigned int);
51 
56  const char* GetPluginStatusMessage(unsigned int);
57 
61  void SetAutoLoad(unsigned int cc, bool);
62 
71  void SetAutoLoadAndForce(unsigned int cc, bool);
72 
76  virtual void CopyFromObject(vtkObject*);
77 
81  virtual void AddInformation(vtkPVInformation*);
82 
87  void Update(vtkPVPluginsInformation* other);
88 
90 
93  virtual void CopyToStream(vtkClientServerStream*);
94  virtual void CopyFromStream(const vtkClientServerStream*);
96 
98 
101  vtkGetStringMacro(SearchPaths);
103 
110  static bool PluginRequirementsSatisfied(
111  vtkPVPluginsInformation* client_plugins, vtkPVPluginsInformation* server_plugins);
112 
113 protected:
116 
117  char* SearchPaths;
118  vtkSetStringMacro(SearchPaths);
119 
120 private:
121  vtkPVPluginsInformation(const vtkPVPluginsInformation&) VTK_DELETE_FUNCTION;
122  void operator=(const vtkPVPluginsInformation&) VTK_DELETE_FUNCTION;
123 
124  class vtkInternals;
125  vtkInternals* Internals;
126 };
127 
128 #endif
virtual void CopyFromStream(const vtkClientServerStream *)
Manage a serialized version of the information.
Store messages for the interpreter.
information about plugins tracked by vtkPVPluginTracker.
void PrintSelf(ostream &os, vtkIndent indent)
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.
Superclass for information objects.