ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMNamedPropertyIterator Class Reference

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

#include <vtkSMNamedPropertyIterator.h>

Inheritance diagram for vtkSMNamedPropertyIterator:
Inheritance graph
[legend]
Collaboration diagram for vtkSMNamedPropertyIterator:
Collaboration graph
[legend]

Public Types

typedef vtkSMPropertyIterator Superclass
 
- Public Types inherited from vtkSMPropertyIterator
typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
void SetPropertyNames (vtkStringList *names)
 Set the names of properties to iterate over. More...
 
virtual void Begin ()
 Go to the first property. More...
 
virtual int IsAtEnd ()
 Returns true if iterator points past the end of the collection. More...
 
virtual void Next ()
 Move to the next property. More...
 
virtual const char * GetKey ()
 Returns the key (name) at the current iterator position. More...
 
virtual const char * GetPropertyLabel ()
 Returns the XMLLabel for self properties and the exposed name for sub-proxy properties. More...
 
virtual vtkSMPropertyGetProperty ()
 Returns the property at the current iterator position. More...
 
- Public Member Functions inherited from vtkSMPropertyIterator
virtual void SetProxy (vtkSMProxy *proxy)
 Set the proxy to be used. More...
 
virtual vtkSMProxyGetProxy ()
 Return the proxy. More...
 
virtual void SetTraverseSubProxies (int)
 If TraverseSubProxies is false, only the properties belonging to the root proxy are returned. More...
 
virtual int GetTraverseSubProxies ()
 If TraverseSubProxies is false, only the properties belonging to the root proxy are returned. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMNamedPropertyIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMNamedPropertyIteratorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMPropertyIterator
static vtkSMPropertyIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMPropertyIteratorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMNamedPropertyIterator ()
 
 ~vtkSMNamedPropertyIterator ()
 
- Protected Member Functions inherited from vtkSMPropertyIterator
 vtkSMPropertyIterator ()
 
 ~vtkSMPropertyIterator ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Protected Attributes

vtkStringListPropertyNames
 
int PropertyNameIndex
 
- Protected Attributes inherited from vtkSMPropertyIterator
vtkSMProxyProxy
 
int TraverseSubProxies
 

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 42 of file vtkSMNamedPropertyIterator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkSMNamedPropertyIterator.h.

Constructor & Destructor Documentation

◆ vtkSMNamedPropertyIterator()

vtkSMNamedPropertyIterator::vtkSMNamedPropertyIterator ( )
protected

◆ ~vtkSMNamedPropertyIterator()

vtkSMNamedPropertyIterator::~vtkSMNamedPropertyIterator ( )
protected

Member Function Documentation

◆ New()

static vtkSMNamedPropertyIterator* vtkSMNamedPropertyIterator::New ( )
static

◆ GetClassName()

virtual const char* vtkSMNamedPropertyIterator::GetClassName ( )
virtual

Reimplemented from vtkSMPropertyIterator.

◆ IsTypeOf()

static int vtkSMNamedPropertyIterator::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkSMNamedPropertyIterator::IsA ( const char *  type)
virtual

Reimplemented from vtkSMPropertyIterator.

◆ SafeDownCast()

static vtkSMNamedPropertyIterator* vtkSMNamedPropertyIterator::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

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

Reimplemented from vtkSMPropertyIterator.

◆ SetPropertyNames()

void vtkSMNamedPropertyIterator::SetPropertyNames ( vtkStringList names)

Set the names of properties to iterate over.

◆ Begin()

virtual void vtkSMNamedPropertyIterator::Begin ( )
virtual

Go to the first property.

Reimplemented from vtkSMPropertyIterator.

◆ IsAtEnd()

virtual int vtkSMNamedPropertyIterator::IsAtEnd ( )
virtual

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

Reimplemented from vtkSMPropertyIterator.

◆ Next()

virtual void vtkSMNamedPropertyIterator::Next ( )
virtual

Move to the next property.

Reimplemented from vtkSMPropertyIterator.

◆ GetKey()

virtual const char* vtkSMNamedPropertyIterator::GetKey ( )
virtual

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

Reimplemented from vtkSMPropertyIterator.

◆ GetPropertyLabel()

virtual const char* vtkSMNamedPropertyIterator::GetPropertyLabel ( )
virtual

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

Reimplemented from vtkSMPropertyIterator.

◆ GetProperty()

virtual vtkSMProperty* vtkSMNamedPropertyIterator::GetProperty ( )
virtual

Returns the property at the current iterator position.

Reimplemented from vtkSMPropertyIterator.

Member Data Documentation

◆ PropertyNames

vtkStringList* vtkSMNamedPropertyIterator::PropertyNames
protected

Definition at line 89 of file vtkSMNamedPropertyIterator.h.

◆ PropertyNameIndex

int vtkSMNamedPropertyIterator::PropertyNameIndex
protected

Definition at line 90 of file vtkSMNamedPropertyIterator.h.


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