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
|
/*=========================================================================
Program: ParaView
Module: $RCSfile$
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.
=========================================================================*/
// .NAME vtkSMPluginManager - manages ParaView plugins.
// .SECTION Description
// vtkSMPluginManager is used to load plugins as well as discover information
// about currently loaded and available plugins.
//
// vtkSMPluginManager supports multiple sessions. Every vtkSMSession registers
// itself with the vtkSMPluginManager during initialization.
#ifndef vtkSMPluginManager_h
#define vtkSMPluginManager_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMObject.h"
class vtkPVPluginsInformation;
class vtkSMSession;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMPluginManager : public vtkSMObject
{
public:
static vtkSMPluginManager* New();
vtkTypeMacro(vtkSMPluginManager, vtkSMObject);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Register/Unregister a session. Every vtkSMSession must be registered with
// the vtkSMPluginManager. This is done automatically by vtkSMSession during
// the initialization stage. Note that the vtkSMSession is not reference
// counted.
void RegisterSession(vtkSMSession*);
void UnRegisterSession(vtkSMSession*);
// Description:
// vtkPVPluginsInformation provides information about plugins
// loaded/available. LocalInformation corresponds to plugins loaded on the
// local process. For remote sessions i.e. those that connect to a remote
// server process, one can use GetRemoteInformation() to access information
// about plugins on the remote process.
vtkGetObjectMacro(LocalInformation, vtkPVPluginsInformation);
vtkPVPluginsInformation* GetRemoteInformation(vtkSMSession*);
// Description:
// Returns the plugin search paths used either locally or remotely. For
// non-remote sessions, GetRemotePluginSearchPaths() returns the same value as
// GetLocalPluginSearchPaths().
const char* GetLocalPluginSearchPaths();
const char* GetRemotePluginSearchPaths(vtkSMSession*);
// Description:
// Loads the plugin either locally or remotely.
bool LoadRemotePlugin(const char* filename, vtkSMSession*);
bool LoadLocalPlugin(const char* filename);
// Description:
// Plugin configuration XML is a simple XML that makes ParaView aware of the
// plugins available and may result in loading of those plugins that are
// marked for auto-loading. In ParaView application there are two uses for this:
// \li .plugins - used to notify ParaView of the distributed plugins
// \li session - used to save/restore the plugins loaded by the users.
//
// This method loads the plugin configuration xml either on the local process or the
// remote server process(es). \c session is only used when
// remote==true and session itself is a remote session.
void LoadPluginConfigurationXMLFromString(const char* xmlcontents,
vtkSMSession* session, bool remote);
enum
{
PluginLoadedEvent = 100000,
LocalPluginLoadedEvent,
RemotePluginLoadedEvent
};
protected:
vtkSMPluginManager();
~vtkSMPluginManager();
bool InLoadPlugin;
void OnPluginRegistered();
vtkPVPluginsInformation* LocalInformation;
private:
vtkSMPluginManager(const vtkSMPluginManager&); // Not implemented
void operator=(const vtkSMPluginManager&); // Not implemented
class vtkInternals;
vtkInternals* Internals;
};
#endif
|
