ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPVProxyDefinitionIterator Class Referenceabstract

iterates over all proxy definitions from which the vtkSMProxyManager can use to create new proxy. More...

#include <vtkPVProxyDefinitionIterator.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void GoToFirstItem ()=0
 Move the iterator to the beginning. More...
 
virtual void InitTraversal ()
 Reset the iterator and move it to the head. More...
 
virtual void GoToNextItem ()=0
 Move the iterator to the next item. More...
 
virtual void GoToNextGroup ()=0
 Move the iterator to the next group. More...
 
virtual bool IsDoneWithTraversal ()=0
 Test whether the iterator is currently pointing to a valid item. More...
 
virtual void AddTraversalGroupName (const char *groupName)=0
 
virtual const char * GetGroupName ()=0
 Return the current group name or NULL if Next() was never called. More...
 
virtual const char * GetProxyName ()=0
 Return the current proxy name or NULL if Next() was never called. More...
 
virtual bool IsCustom ()
 Return true if the current definition has been defined in the Custom scope. More...
 
virtual vtkPVXMLElementGetProxyDefinition ()=0
 Return the current XML proxy definition. More...
 
virtual vtkPVXMLElementGetProxyHints ()=0
 Return the current XML proxy hints. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVProxyDefinitionIteratorSafeDownCast (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 38 of file vtkPVProxyDefinitionIterator.h.

Member Typedef Documentation

§ Superclass

Definition at line 41 of file vtkPVProxyDefinitionIterator.h.

Constructor & Destructor Documentation

§ vtkPVProxyDefinitionIterator()

vtkPVProxyDefinitionIterator::vtkPVProxyDefinitionIterator ( )
protected

§ ~vtkPVProxyDefinitionIterator()

virtual vtkPVProxyDefinitionIterator::~vtkPVProxyDefinitionIterator ( )
protectedvirtual

Member Function Documentation

§ GetClassName()

virtual const char* vtkPVProxyDefinitionIterator::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ GoToFirstItem()

virtual void vtkPVProxyDefinitionIterator::GoToFirstItem ( )
pure virtual

Move the iterator to the beginning.

§ InitTraversal()

virtual void vtkPVProxyDefinitionIterator::InitTraversal ( )
inlinevirtual

Reset the iterator and move it to the head.

Definition at line 54 of file vtkPVProxyDefinitionIterator.h.

§ GoToNextItem()

virtual void vtkPVProxyDefinitionIterator::GoToNextItem ( )
pure virtual

Move the iterator to the next item.

This will also move to next group automatically if needed.

§ GoToNextGroup()

virtual void vtkPVProxyDefinitionIterator::GoToNextGroup ( )
pure virtual

Move the iterator to the next group.

§ IsDoneWithTraversal()

virtual bool vtkPVProxyDefinitionIterator::IsDoneWithTraversal ( )
pure virtual

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

§ AddTraversalGroupName()

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

§ GetGroupName()

virtual const char* vtkPVProxyDefinitionIterator::GetGroupName ( )
pure virtual

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

§ GetProxyName()

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

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

§ IsCustom()

virtual bool vtkPVProxyDefinitionIterator::IsCustom ( )
inlinevirtual

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

Definition at line 85 of file vtkPVProxyDefinitionIterator.h.

§ GetProxyDefinition()

virtual vtkPVXMLElement* vtkPVProxyDefinitionIterator::GetProxyDefinition ( )
pure virtual

Return the current XML proxy definition.

§ GetProxyHints()

virtual vtkPVXMLElement* vtkPVProxyDefinitionIterator::GetProxyHints ( )
pure virtual

Return the current XML proxy hints.


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