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
|
/*=========================================================================
Program: ParaView
Module: vtkSMProxyLocator.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 vtkSMProxyLocator
* @brief is used to locate proxies referred to in state xmls
* while loading state files.
*
* vtkSMProxyLocator is used to locate proxies referred to in state xmls (and
* otherwise) when loading state files.
*/
#ifndef vtkSMProxyLocator_h
#define vtkSMProxyLocator_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMObject.h"
#include "vtkWeakPointer.h" // needed to keep the session around
class vtkCollection;
class vtkSMDeserializer;
class vtkSMProxy;
class vtkSMSession;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMProxyLocator : public vtkSMObject
{
public:
static vtkSMProxyLocator* New();
vtkTypeMacro(vtkSMProxyLocator, vtkSMObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Locate a proxy with the given "name". If none can be found returns NULL.
* If a proxy with the name was not previously located, it will ask the
* Deserializer (if any) to create a new proxy is possible.
*/
virtual vtkSMProxy* LocateProxy(vtkTypeUInt32 globalID);
//@{
/**
* Get/Set the de-serializer to used to locate XMLs/Protobuf for unknown proxies
* requested to be located using LocateProxy().
*/
void SetDeserializer(vtkSMDeserializer*);
vtkGetObjectMacro(Deserializer, vtkSMDeserializer);
//@}
//@{
/**
* Get/Set the session.
*/
virtual vtkSMSession* GetSession();
virtual void SetSession(vtkSMSession* s);
//@}
/**
* Clear the locator.
*/
virtual void Clear();
/**
* Copy all the Located proxy into the collection.
* This allow to keep a reference to them outside of the current locator.
* This is needed if we don't want to delete those proxy and if we want to
* Clear() the current ProxyLocator.
*/
virtual void GetLocatedProxies(vtkCollection* collectionToFill);
virtual void UseSessionToLocateProxy(bool useSessionToo)
{
this->LocateProxyWithSessionToo = useSessionToo;
}
/**
* For custom applications managing custom state loading, one can use this
* method to register proxies with locator to use when LocateProxy()
* before attempting the standard route i.e. using the deserializer or
* session.
*/
virtual void AssignProxy(vtkTypeUInt32 id, vtkSMProxy* proxy);
protected:
vtkSMProxyLocator();
~vtkSMProxyLocator();
/**
* Create new proxy with the given id. Default implementation asks the
* Deserializer, if any, to create a new proxy.
*/
virtual vtkSMProxy* NewProxy(vtkTypeUInt32 globalID);
vtkSMDeserializer* Deserializer;
vtkWeakPointer<vtkSMSession> Session;
bool LocateProxyWithSessionToo;
private:
vtkSMProxyLocator(const vtkSMProxyLocator&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMProxyLocator&) VTK_DELETE_FUNCTION;
class vtkInternal;
vtkInternal* Internal;
};
#endif
|
