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
|
/*=========================================================================
Program: ParaView
Module: vtkSMOrderedPropertyIterator.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 vtkSMOrderedPropertyIterator
* @brief iterates over the properties of a proxy
*
* vtkSMOrderedPropertyIterator is used to iterate over the properties of a
* proxy. The properties of the root proxies as well as sub-proxies are
* included in the iteration. For sub-proxies, only exposed properties are
* iterated over. vtkSMOrderedPropertyIterator iterates over properties in
* the order they appear in the xml or in the order they were added. This
* is possible because vtkSMProxy keeps track of the order in which properties
* were added or exposed in a PropertyNamesInOrder vector.
*/
#ifndef vtkSMOrderedPropertyIterator_h
#define vtkSMOrderedPropertyIterator_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMObject.h"
class vtkSMProperty;
class vtkSMProxy;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMOrderedPropertyIterator : public vtkSMObject
{
public:
static vtkSMOrderedPropertyIterator* New();
vtkTypeMacro(vtkSMOrderedPropertyIterator, vtkSMObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Set the proxy to be used.
*/
void SetProxy(vtkSMProxy* proxy);
//@{
/**
* Return the proxy.
*/
vtkGetObjectMacro(Proxy, vtkSMProxy);
//@}
/**
* Go to the first property.
*/
void Begin();
/**
* Returns true if iterator points past the end of the collection.
*/
int IsAtEnd();
/**
* Move to the next property.
*/
void Next();
/**
* Returns the key (name) at the current iterator position.
*/
const char* GetKey();
/**
* Returns the property at the current iterator position.
*/
vtkSMProperty* GetProperty();
/**
* Returns the XMLLabel for self properties and the exposed name for
* sub-proxy properties.
*/
const char* GetPropertyLabel();
protected:
vtkSMOrderedPropertyIterator();
~vtkSMOrderedPropertyIterator();
vtkSMProxy* Proxy;
unsigned int Index;
private:
vtkSMOrderedPropertyIterator(const vtkSMOrderedPropertyIterator&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMOrderedPropertyIterator&) VTK_DELETE_FUNCTION;
};
#endif
|
