vtkSMProxyIterator.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
13 #ifndef vtkSMProxyIterator_h
14 #define vtkSMProxyIterator_h
15 
16 #include "vtkRemotingServerManagerModule.h" //needed for exports
17 #include "vtkSMObject.h"
18 
19 struct vtkSMProxyIteratorInternals;
20 
21 class vtkSMProxy;
22 class vtkSMSession;
24 
26 {
27 public:
28  static vtkSMProxyIterator* New();
30  void PrintSelf(ostream& os, vtkIndent indent) override;
31 
35  void SetSessionProxyManager(vtkSMSessionProxyManager*);
36 
41  void SetSession(vtkSMSession* session);
42 
46  void Begin();
47 
51  void Begin(const char* groupName);
52 
56  int IsAtEnd();
57 
61  void Next();
62 
66  const char* GetGroup();
67 
71  const char* GetKey();
72 
76  vtkSMProxy* GetProxy();
77 
79 
85  vtkSetMacro(Mode, int);
86  vtkGetMacro(Mode, int);
87  void SetModeToGroupsOnly() { this->SetMode(GROUPS_ONLY); }
88  void SetModeToOneGroup() { this->SetMode(ONE_GROUP); }
89  void SetModeToAll() { this->SetMode(ALL); }
91 
93 
96  vtkSetMacro(SkipPrototypes, bool);
97  vtkGetMacro(SkipPrototypes, bool);
98  vtkBooleanMacro(SkipPrototypes, bool);
100 
102  {
103  GROUPS_ONLY = 0,
104  ONE_GROUP = 1,
105  ALL = 2
106  };
107 
108 protected:
110  ~vtkSMProxyIterator() override;
111 
113  int Mode;
114  void NextInternal();
115 
116 private:
117  vtkSMProxyIteratorInternals* Internals;
118 
119  vtkSMProxyIterator(const vtkSMProxyIterator&) = delete;
120  void operator=(const vtkSMProxyIterator&) = delete;
121 };
122 
123 #endif
#define VTKREMOTINGSERVERMANAGER_EXPORT
vtkSMSession is the default ParaView session.
Definition: vtkSMSession.h:22
void SetModeToGroupsOnly()
The traversal mode for the iterator.
void SetModeToAll()
The traversal mode for the iterator.
superclass for most server manager classes
Definition: vtkSMObject.h:17
The vtkSMSessionProxyManager is esponsible for creating and managing proxies for a given session...
static vtkSMObject * New()
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:140
void SetModeToOneGroup()
The traversal mode for the iterator.
iterates over all registered proxies (and groups)
void PrintSelf(ostream &os, vtkIndent indent) override