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

iterates over the properties of a proxy More...

#include <vtkSMPropertyIterator.h>

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

Public Types

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)
 
virtual void SetProxy (vtkSMProxy *proxy)
 Set the proxy to be used. 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...
 
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 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

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

Protected Attributes

vtkSMProxyProxy
 
int TraverseSubProxies
 

Detailed Description

iterates over the properties of a proxy

vtkSMPropertyIterator 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.

Definition at line 36 of file vtkSMPropertyIterator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkSMPropertyIterator.h.

Constructor & Destructor Documentation

◆ vtkSMPropertyIterator()

vtkSMPropertyIterator::vtkSMPropertyIterator ( )
protected

◆ ~vtkSMPropertyIterator()

vtkSMPropertyIterator::~vtkSMPropertyIterator ( )
protected

Member Function Documentation

◆ New()

static vtkSMPropertyIterator* vtkSMPropertyIterator::New ( )
static

◆ GetClassName()

virtual const char* vtkSMPropertyIterator::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMNamedPropertyIterator.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMObject.

Reimplemented in vtkSMNamedPropertyIterator.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented in vtkSMNamedPropertyIterator.

◆ SetProxy()

virtual void vtkSMPropertyIterator::SetProxy ( vtkSMProxy proxy)
virtual

Set the proxy to be used.

◆ GetProxy()

virtual vtkSMProxy* vtkSMPropertyIterator::GetProxy ( )
virtual

Return the proxy.

◆ Begin()

virtual void vtkSMPropertyIterator::Begin ( )
virtual

Go to the first property.

Reimplemented in vtkSMNamedPropertyIterator.

◆ IsAtEnd()

virtual int vtkSMPropertyIterator::IsAtEnd ( )
virtual

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

Reimplemented in vtkSMNamedPropertyIterator.

◆ Next()

virtual void vtkSMPropertyIterator::Next ( )
virtual

Move to the next property.

Reimplemented in vtkSMNamedPropertyIterator.

◆ GetKey()

virtual const char* vtkSMPropertyIterator::GetKey ( )
virtual

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

Reimplemented in vtkSMNamedPropertyIterator.

◆ GetPropertyLabel()

virtual const char* vtkSMPropertyIterator::GetPropertyLabel ( )
virtual

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

Reimplemented in vtkSMNamedPropertyIterator.

◆ GetProperty()

virtual vtkSMProperty* vtkSMPropertyIterator::GetProperty ( )
virtual

Returns the property at the current iterator position.

Reimplemented in vtkSMNamedPropertyIterator.

◆ SetTraverseSubProxies()

virtual void vtkSMPropertyIterator::SetTraverseSubProxies ( int  )
virtual

If TraverseSubProxies is false, only the properties belonging to the root proxy are returned.

Default is true.

◆ GetTraverseSubProxies()

virtual int vtkSMPropertyIterator::GetTraverseSubProxies ( )
virtual

If TraverseSubProxies is false, only the properties belonging to the root proxy are returned.

Default is true.

Member Data Documentation

◆ Proxy

vtkSMProxy* vtkSMPropertyIterator::Proxy
protected

Definition at line 99 of file vtkSMPropertyIterator.h.

◆ TraverseSubProxies

int vtkSMPropertyIterator::TraverseSubProxies
protected

Definition at line 101 of file vtkSMPropertyIterator.h.


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