Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkSMProxyIterator Class Reference

iterates over all registered proxies (and groups) More...

#include <vtkSMProxyIterator.h>

Inheritance diagram for vtkSMProxyIterator:

Inheritance graph
[legend]
Collaboration diagram for vtkSMProxyIterator:

Collaboration graph
[legend]
List of all members.

Public Types

enum  TraversalMode { GROUPS_ONLY = 0, ONE_GROUP = 1, ALL = 2 }

Public Member Functions

 vtkTypeRevisionMacro (vtkSMProxyIterator, vtkSMObject)
void PrintSelf (ostream &os, vtkIndent indent)
void Begin ()
void Begin (const char *groupName)
int IsAtEnd ()
void Next ()
const char * GetGroup ()
const char * GetKey ()
vtkSMProxyGetProxy ()
virtual void SetMode (int)
virtual int GetMode ()

Static Public Member Functions

vtkSMProxyIteratorNew ()

Protected Member Functions

 vtkSMProxyIterator ()
 ~vtkSMProxyIterator ()
virtual void SaveState (const char *, ostream *, vtkIndent)

Protected Attributes

int Mode

Detailed Description

iterates over all registered proxies (and groups)

vtkSMProxyIterator iterates over all proxies registered with the proxy manager. It can also iterate over groups.

See also:
vtkSMProxy vtkSMProxyManager

Definition at line 36 of file vtkSMProxyIterator.h.


Member Enumeration Documentation

enum vtkSMProxyIterator::TraversalMode
 

Enumeration values:
GROUPS_ONLY 
ONE_GROUP 
ALL 

Definition at line 74 of file vtkSMProxyIterator.h.


Constructor & Destructor Documentation

vtkSMProxyIterator::vtkSMProxyIterator  )  [protected]
 

vtkSMProxyIterator::~vtkSMProxyIterator  )  [protected]
 


Member Function Documentation

vtkSMProxyIterator* vtkSMProxyIterator::New  )  [static]
 

Reimplemented from vtkSMObject.

vtkSMProxyIterator::vtkTypeRevisionMacro vtkSMProxyIterator  ,
vtkSMObject 
 

void vtkSMProxyIterator::PrintSelf ostream &  os,
vtkIndent  indent
 

Reimplemented from vtkSMObject.

void vtkSMProxyIterator::Begin  ) 
 

Go to the beginning of the collection.

void vtkSMProxyIterator::Begin const char *  groupName  ) 
 

Go to the beginning of one group.

int vtkSMProxyIterator::IsAtEnd  ) 
 

Is the iterator pointing past the last element?

void vtkSMProxyIterator::Next  ) 
 

Move to the next property.

const char* vtkSMProxyIterator::GetGroup  ) 
 

Get the group at the current iterator location.

const char* vtkSMProxyIterator::GetKey  ) 
 

Get the key (proxy name) at the current iterator location.

vtkSMProxy* vtkSMProxyIterator::GetProxy  ) 
 

Get the proxy at the current iterator location.

virtual void vtkSMProxyIterator::SetMode int   )  [virtual]
 

The traversal mode for the iterator. If the traversal mode is set to GROUPS, each Next() will move to the next group, in ONE_GROUP mode, all proxies in one group are visited and finally in ALL mode, all proxies are visited.

virtual int vtkSMProxyIterator::GetMode  )  [virtual]
 

The traversal mode for the iterator. If the traversal mode is set to GROUPS, each Next() will move to the next group, in ONE_GROUP mode, all proxies in one group are visited and finally in ALL mode, all proxies are visited.

virtual void vtkSMProxyIterator::SaveState const char *  ,
ostream *  ,
vtkIndent 
[inline, protected, virtual]
 

Saves the state of the object in XML format. Should be overwritten by proxies and properties.

Reimplemented from vtkSMObject.

Definition at line 88 of file vtkSMProxyIterator.h.


Member Data Documentation

int vtkSMProxyIterator::Mode [protected]
 

Definition at line 86 of file vtkSMProxyIterator.h.


The documentation for this class was generated from the following file:
Generated on Tue May 30 12:42:10 2006 for ParaView by doxygen 1.3.5