vtkSMProxyLocator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkSMProxyLocator.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 vtkSMProxyLocator_h
25 #define vtkSMProxyLocator_h
26 
27 #include "vtkRemotingServerManagerModule.h" //needed for exports
28 #include "vtkSMObject.h"
29 #include "vtkWeakPointer.h" // needed to keep the session around
30 
31 class vtkCollection;
32 class vtkSMDeserializer;
33 class vtkSMProxy;
34 class vtkSMSession;
35 
37 {
38 public:
39  static vtkSMProxyLocator* New();
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
48  virtual vtkSMProxy* LocateProxy(vtkTypeUInt32 globalID);
49 
51 
55  void SetDeserializer(vtkSMDeserializer*);
56  vtkGetObjectMacro(Deserializer, vtkSMDeserializer);
58 
60 
63  virtual vtkSMSession* GetSession();
64  virtual void SetSession(vtkSMSession* s);
66 
70  virtual void Clear();
71 
78  virtual void GetLocatedProxies(vtkCollection* collectionToFill);
79 
80  virtual void UseSessionToLocateProxy(bool useSessionToo)
81  {
82  this->LocateProxyWithSessionToo = useSessionToo;
83  }
84 
91  virtual void AssignProxy(vtkTypeUInt32 id, vtkSMProxy* proxy);
92 
93 protected:
95  ~vtkSMProxyLocator() override;
96 
101  virtual vtkSMProxy* NewProxy(vtkTypeUInt32 globalID);
102 
106 
107 private:
108  vtkSMProxyLocator(const vtkSMProxyLocator&) = delete;
109  void operator=(const vtkSMProxyLocator&) = delete;
110 
111  class vtkInternal;
112  vtkInternal* Internal;
113 };
114 
115 #endif
#define VTKREMOTINGSERVERMANAGER_EXPORT
vtkSMSession is the default ParaView session.
Definition: vtkSMSession.h:35
virtual void UseSessionToLocateProxy(bool useSessionToo)
deserializes proxies from their states.
superclass for most server manager classes
Definition: vtkSMObject.h:29
vtkSMDeserializer * Deserializer
static vtkSMObject * New()
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152
is used to locate proxies referred to in state xmls while loading state files.
vtkWeakPointer< vtkSMSession > Session
void PrintSelf(ostream &os, vtkIndent indent) override