ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkPVProxyDefinitionIterator Class Reference

iterates over all proxy definitions from which the vtkSMProxyManager can use to create new proxy. It can also iterate over registered compound proxy definitions. More...

#include <vtkPVProxyDefinitionIterator.h>

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

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void GoToFirstItem ()=0
virtual void GoToNextItem ()=0
virtual void GoToNextGroup ()=0
virtual bool IsDoneWithTraversal ()=0
virtual void AddTraversalGroupName (const char *groupName)=0
virtual const char * GetGroupName ()=0
 Return the current group name or NULL if Next() was never called.
virtual const char * GetProxyName ()=0
 Return the current proxy name or NULL if Next() was never called.
virtual bool IsCustom ()
 Return true if the current definition has been defined in the Custom scope.
virtual vtkPVXMLElementGetProxyDefinition ()=0
 Return the current XML proxy definition.
virtual vtkPVXMLElementGetProxyHints ()=0
 Return the current XML proxy hints.
virtual void InitTraversal ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static
vtkPVProxyDefinitionIterator
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPVProxyDefinitionIterator ()
virtual ~vtkPVProxyDefinitionIterator ()

Detailed Description

iterates over all proxy definitions from which the vtkSMProxyManager can use to create new proxy. It can also iterate over registered compound proxy definitions.

vtkPVProxyDefinitionIterator iterates over all proxy definitions known to the proxy manager. The iterator allow to filter the iteration on a subset of group and/or on the global or custom proxies. Custom and Compound proxy are exactly the same thing. We should stick with only one name.

See also:
vtkSMProxyManager

Definition at line 36 of file vtkPVProxyDefinitionIterator.h.


Constructor & Destructor Documentation

vtkPVProxyDefinitionIterator::vtkPVProxyDefinitionIterator ( ) [protected]
virtual vtkPVProxyDefinitionIterator::~vtkPVProxyDefinitionIterator ( ) [protected, virtual]

Member Function Documentation

virtual const char* vtkPVProxyDefinitionIterator::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

static int vtkPVProxyDefinitionIterator::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkObject.

virtual int vtkPVProxyDefinitionIterator::IsA ( const char *  type) [virtual]

Reimplemented from vtkObject.

static vtkPVProxyDefinitionIterator* vtkPVProxyDefinitionIterator::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

virtual void vtkPVProxyDefinitionIterator::GoToFirstItem ( ) [pure virtual]

Move the iterator to the beginning.

virtual void vtkPVProxyDefinitionIterator::InitTraversal ( ) [inline, virtual]

Reset the iterator and move it to the head.

Definition at line 49 of file vtkPVProxyDefinitionIterator.h.

virtual void vtkPVProxyDefinitionIterator::GoToNextItem ( ) [pure virtual]

Move the iterator to the next item. This will also move to next group automatically if needed.

virtual void vtkPVProxyDefinitionIterator::GoToNextGroup ( ) [pure virtual]

Move the iterator to the next group.

virtual bool vtkPVProxyDefinitionIterator::IsDoneWithTraversal ( ) [pure virtual]

Test whether the iterator is currently pointing to a valid item.

virtual void vtkPVProxyDefinitionIterator::AddTraversalGroupName ( const char *  groupName) [pure virtual]
virtual const char* vtkPVProxyDefinitionIterator::GetGroupName ( ) [pure virtual]

Return the current group name or NULL if Next() was never called.

virtual const char* vtkPVProxyDefinitionIterator::GetProxyName ( ) [pure virtual]

Return the current proxy name or NULL if Next() was never called.

virtual bool vtkPVProxyDefinitionIterator::IsCustom ( ) [inline, virtual]

Return true if the current definition has been defined in the Custom scope.

Definition at line 76 of file vtkPVProxyDefinitionIterator.h.

virtual vtkPVXMLElement* vtkPVProxyDefinitionIterator::GetProxyDefinition ( ) [pure virtual]

Return the current XML proxy definition.

virtual vtkPVXMLElement* vtkPVProxyDefinitionIterator::GetProxyHints ( ) [pure virtual]

Return the current XML proxy hints.


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