vtkSMNamedPropertyIterator.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
20 #ifndef vtkSMNamedPropertyIterator_h
21 #define vtkSMNamedPropertyIterator_h
22 
23 #include "vtkRemotingServerManagerModule.h" //needed for exports
24 #include "vtkSMPropertyIterator.h"
25 
26 #include <string> // for std::string
27 #include <vector> // for std::vector
28 
29 class vtkSMProperty;
30 class vtkSMProxy;
31 class vtkStringList;
32 
33 class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMNamedPropertyIterator : public vtkSMPropertyIterator
34 {
35 public:
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39 
41 
44  void SetPropertyNames(vtkStringList* names);
45  void SetPropertyNames(const std::vector<std::string>& names);
47 
51  void Begin() override;
52 
56  int IsAtEnd() override;
57 
61  void Next() override;
62 
66  const char* GetKey() override;
67 
72  const char* GetPropertyLabel() override;
73 
77  vtkSMProperty* GetProperty() override;
78 
79 protected:
81  ~vtkSMNamedPropertyIterator() override;
82 
85 
86 private:
88  void operator=(const vtkSMNamedPropertyIterator&) = delete;
89 };
90 
91 #endif
vtkSMPropertyIterator::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
vtkSMPropertyIterator::GetPropertyLabel
virtual const char * GetPropertyLabel()
Returns the XMLLabel for self properties and the exposed name for sub-proxy properties.
vtkSMPropertyIterator::Begin
virtual void Begin()
Go to the first property.
vtkSMPropertyIterator::New
static vtkSMPropertyIterator * New()
vtkSMPropertyIterator::Next
virtual void Next()
Move to the next property.
vtkSMProperty
superclass for all SM properties
Definition: vtkSMProperty.h:144
vtkSMNamedPropertyIterator::PropertyNameIndex
int PropertyNameIndex
Definition: vtkSMNamedPropertyIterator.h:84
vtkSMProxy
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:140
vtkSMPropertyIterator::GetProperty
virtual vtkSMProperty * GetProperty()
Returns the property at the current iterator position.
vtkSMPropertyIterator.h
vtkSMNamedPropertyIterator::PropertyNames
vtkStringList * PropertyNames
Definition: vtkSMNamedPropertyIterator.h:83
vtkIndent
vtkSMPropertyIterator::GetKey
virtual const char * GetKey()
Returns the key (name) at the current iterator position.
vtkStringList
Manages allocation and freeing for a string list.
Definition: vtkStringList.h:18
vtkSMNamedPropertyIterator
iterates over a subset of a proxy's properties
Definition: vtkSMNamedPropertyIterator.h:33
vtkSMPropertyIterator::IsAtEnd
virtual int IsAtEnd()
Returns true if iterator points past the end of the collection.
vtkSMPropertyIterator
iterates over the properties of a proxy
Definition: vtkSMPropertyIterator.h:24