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

iterates over the properties of a proxy More...

#include <vtkSMOrderedPropertyIterator.h>

Inheritance diagram for vtkSMOrderedPropertyIterator:
Inheritance graph
[legend]
Collaboration diagram for vtkSMOrderedPropertyIterator:
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)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetProxy (vtkSMProxy *proxy)
 Set the proxy to be used. More...
 
void Begin ()
 Go to the first property. More...
 
int IsAtEnd ()
 Returns true if iterator points past the end of the collection. More...
 
void Next ()
 Move to the next property. More...
 
const char * GetKey ()
 Returns the key (name) at the current iterator position. More...
 
vtkSMPropertyGetProperty ()
 Returns the property at the current iterator position. More...
 
const char * GetPropertyLabel ()
 Returns the XMLLabel for self properties and the exposed name for sub-proxy properties. More...
 
virtual vtkSMProxyGetProxy ()
 Return the proxy. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMOrderedPropertyIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMOrderedPropertyIteratorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

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

Protected Attributes

vtkSMProxyProxy
 
unsigned int Index
 

Detailed Description

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.

Definition at line 37 of file vtkSMOrderedPropertyIterator.h.

Member Typedef Documentation

§ Superclass

Definition at line 41 of file vtkSMOrderedPropertyIterator.h.

Constructor & Destructor Documentation

§ vtkSMOrderedPropertyIterator()

vtkSMOrderedPropertyIterator::vtkSMOrderedPropertyIterator ( )
protected

§ ~vtkSMOrderedPropertyIterator()

vtkSMOrderedPropertyIterator::~vtkSMOrderedPropertyIterator ( )
protected

Member Function Documentation

§ New()

static vtkSMOrderedPropertyIterator* vtkSMOrderedPropertyIterator::New ( )
static

§ GetClassName()

virtual const char* vtkSMOrderedPropertyIterator::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMObject.

§ SafeDownCast()

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

§ PrintSelf()

void vtkSMOrderedPropertyIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ SetProxy()

void vtkSMOrderedPropertyIterator::SetProxy ( vtkSMProxy proxy)

Set the proxy to be used.

§ GetProxy()

virtual vtkSMProxy* vtkSMOrderedPropertyIterator::GetProxy ( )
virtual

Return the proxy.

§ Begin()

void vtkSMOrderedPropertyIterator::Begin ( )

Go to the first property.

§ IsAtEnd()

int vtkSMOrderedPropertyIterator::IsAtEnd ( )

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

§ Next()

void vtkSMOrderedPropertyIterator::Next ( )

Move to the next property.

§ GetKey()

const char* vtkSMOrderedPropertyIterator::GetKey ( )

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

§ GetProperty()

vtkSMProperty* vtkSMOrderedPropertyIterator::GetProperty ( )

Returns the property at the current iterator position.

§ GetPropertyLabel()

const char* vtkSMOrderedPropertyIterator::GetPropertyLabel ( )

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

Member Data Documentation

§ Proxy

vtkSMProxy* vtkSMOrderedPropertyIterator::Proxy
protected

Definition at line 91 of file vtkSMOrderedPropertyIterator.h.

§ Index

unsigned int vtkSMOrderedPropertyIterator::Index
protected

Definition at line 92 of file vtkSMOrderedPropertyIterator.h.


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