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
|
/*=========================================================================
Program: ParaView
Module: vtkSMNamedPropertyIterator.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 vtkSMNamedPropertyIterator
* @brief iterates over a subset of a proxy's properties
*
*
* vtkSMNamedPropertyIterator can be used to iterate over a subset of a proxy's
* properties. The subset is defined through a list of strings naming properties.
* 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.
*
* @sa
* vtkSMPropertyIterator
*
* @par Thanks:
* This class was contributed by SciberQuest Inc.
*/
#ifndef vtkSMNamedPropertyIterator_h
#define vtkSMNamedPropertyIterator_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMPropertyIterator.h"
class vtkSMProperty;
class vtkSMProxy;
class vtkStringList;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMNamedPropertyIterator : public vtkSMPropertyIterator
{
public:
static vtkSMNamedPropertyIterator* New();
vtkTypeMacro(vtkSMNamedPropertyIterator, vtkSMPropertyIterator);
virtual void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Set the names of properties to iterate over.
*/
void SetPropertyNames(vtkStringList* names);
/**
* Go to the first property.
*/
virtual void Begin() VTK_OVERRIDE;
/**
* Returns true if iterator points past the end of the collection.
*/
virtual int IsAtEnd() VTK_OVERRIDE;
/**
* Move to the next property.
*/
virtual void Next() VTK_OVERRIDE;
/**
* Returns the key (name) at the current iterator position.
*/
virtual const char* GetKey() VTK_OVERRIDE;
/**
* Returns the XMLLabel for self properties and the exposed name for
* sub-proxy properties.
*/
virtual const char* GetPropertyLabel() VTK_OVERRIDE;
/**
* Returns the property at the current iterator position.
*/
virtual vtkSMProperty* GetProperty() VTK_OVERRIDE;
protected:
vtkSMNamedPropertyIterator();
~vtkSMNamedPropertyIterator();
vtkStringList* PropertyNames;
int PropertyNameIndex;
private:
vtkSMNamedPropertyIterator(const vtkSMNamedPropertyIterator&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMNamedPropertyIterator&) VTK_DELETE_FUNCTION;
};
#endif
|