vtkSMNamedPropertyIterator Class Reference

iterates over a subset of a proxy's properties More...

#include <vtkSMNamedPropertyIterator.h>

Inheritance diagram for vtkSMNamedPropertyIterator:

Collaboration diagram for vtkSMNamedPropertyIterator:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
void	SetPropertyNames (vtkStringList *names)
virtual void	Begin ()
virtual int	IsAtEnd ()
virtual void	Next ()
virtual const char *	GetKey ()
virtual const char *	GetPropertyLabel ()
virtual vtkSMProperty *	GetProperty ()
Static Public Member Functions
static vtkSMNamedPropertyIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkSMNamedPropertyIterator *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMNamedPropertyIterator ()
	~vtkSMNamedPropertyIterator ()
Protected Attributes
vtkStringList *	PropertyNames
int	PropertyNameIndex

---

Detailed Description

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.

See also:

vtkSMPropertyIterator

Thanks:

This class was contributed by SciberQuest Inc.

Definition at line 40 of file vtkSMNamedPropertyIterator.h.

---

Constructor & Destructor Documentation

vtkSMNamedPropertyIterator::vtkSMNamedPropertyIterator

(

)

[protected]

vtkSMNamedPropertyIterator::~vtkSMNamedPropertyIterator

(

)

[protected]

---

Member Function Documentation

static vtkSMNamedPropertyIterator* vtkSMNamedPropertyIterator::New

(

)

[static]

Reimplemented from vtkSMPropertyIterator.

virtual const char* vtkSMNamedPropertyIterator::GetClassName

(

)

[virtual]

Reimplemented from vtkSMPropertyIterator.

static int vtkSMNamedPropertyIterator::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMPropertyIterator.

virtual int vtkSMNamedPropertyIterator::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMPropertyIterator.

static vtkSMNamedPropertyIterator* vtkSMNamedPropertyIterator::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMPropertyIterator.

virtual void vtkSMNamedPropertyIterator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Reimplemented from vtkSMPropertyIterator.

void vtkSMNamedPropertyIterator::SetPropertyNames

(

vtkStringList *

names

)

Set the names of properties to iterate over.

virtual void vtkSMNamedPropertyIterator::Begin

(

)

[virtual]

Go to the first property.

Reimplemented from vtkSMPropertyIterator.

virtual int vtkSMNamedPropertyIterator::IsAtEnd

(

)

[virtual]

Returns true if iterator points past the end of the collection.

Reimplemented from vtkSMPropertyIterator.

virtual void vtkSMNamedPropertyIterator::Next

(

)

[virtual]

Move to the next property.

Reimplemented from vtkSMPropertyIterator.

virtual const char* vtkSMNamedPropertyIterator::GetKey

(

)

[virtual]

Returns the key (name) at the current iterator position.

Reimplemented from vtkSMPropertyIterator.

virtual const char* vtkSMNamedPropertyIterator::GetPropertyLabel

(

)

[virtual]

Returns the XMLLabel for self properties and the exposed name for sub-proxy properties.

Reimplemented from vtkSMPropertyIterator.

virtual vtkSMProperty* vtkSMNamedPropertyIterator::GetProperty

(

)

[virtual]

Returns the property at the current iterator position.

Reimplemented from vtkSMPropertyIterator.

---

Member Data Documentation

vtkStringList* vtkSMNamedPropertyIterator::PropertyNames [protected]

Definition at line 73 of file vtkSMNamedPropertyIterator.h.

int vtkSMNamedPropertyIterator::PropertyNameIndex [protected]

Definition at line 74 of file vtkSMNamedPropertyIterator.h.

---

The documentation for this class was generated from the following file:

• dox/ParaViewCore/ServerManager/vtkSMNamedPropertyIterator.h