vtkSMProxyIterator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkSMProxyIterator.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 =========================================================================*/
25 #ifndef vtkSMProxyIterator_h
26 #define vtkSMProxyIterator_h
27 
28 #include "vtkRemotingServerManagerModule.h" //needed for exports
29 #include "vtkSMObject.h"
30 
31 struct vtkSMProxyIteratorInternals;
32 
33 class vtkSMProxy;
34 class vtkSMSession;
36 
38 {
39 public:
40  static vtkSMProxyIterator* New();
42  void PrintSelf(ostream& os, vtkIndent indent) override;
43 
47  void SetSessionProxyManager(vtkSMSessionProxyManager*);
48 
53  void SetSession(vtkSMSession* session);
54 
58  void Begin();
59 
63  void Begin(const char* groupName);
64 
68  int IsAtEnd();
69 
73  void Next();
74 
78  const char* GetGroup();
79 
83  const char* GetKey();
84 
88  vtkSMProxy* GetProxy();
89 
91 
97  vtkSetMacro(Mode, int);
98  vtkGetMacro(Mode, int);
99  void SetModeToGroupsOnly() { this->SetMode(GROUPS_ONLY); }
100  void SetModeToOneGroup() { this->SetMode(ONE_GROUP); }
101  void SetModeToAll() { this->SetMode(ALL); }
103 
105 
108  vtkSetMacro(SkipPrototypes, bool);
109  vtkGetMacro(SkipPrototypes, bool);
110  vtkBooleanMacro(SkipPrototypes, bool);
112 
114  {
115  GROUPS_ONLY = 0,
116  ONE_GROUP = 1,
117  ALL = 2
118  };
119 
120 protected:
122  ~vtkSMProxyIterator() override;
123 
125  int Mode;
126  void NextInternal();
127 
128 private:
129  vtkSMProxyIteratorInternals* Internals;
130 
131  vtkSMProxyIterator(const vtkSMProxyIterator&) = delete;
132  void operator=(const vtkSMProxyIterator&) = delete;
133 };
134 
135 #endif
#define VTKREMOTINGSERVERMANAGER_EXPORT
vtkSMSession is the default ParaView session.
Definition: vtkSMSession.h:35
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:29
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:152
void SetModeToOneGroup()
The traversal mode for the iterator.
iterates over all registered proxies (and groups)
void PrintSelf(ostream &os, vtkIndent indent) override