ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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]

Public Types

enum  TraversalMode { GROUPS_ONLY = 0, ONE_GROUP = 1, ALL = 2 }
 
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 SetSessionProxyManager (vtkSMSessionProxyManager *)
 Override the set sesssion so the SessionProxyManager could be cache for. More...
 
void SetSession (vtkSMSession *session)
 Convenience method. More...
 
void Begin ()
 Go to the beginning of the collection. More...
 
void Begin (const char *groupName)
 Go to the beginning of one group, and set mode to iterate over one group. More...
 
int IsAtEnd ()
 Is the iterator pointing past the last element? More...
 
void Next ()
 Move to the next property. More...
 
const char * GetGroup ()
 Get the group at the current iterator location. More...
 
const char * GetKey ()
 Get the key (proxy name) at the current iterator location. More...
 
vtkSMProxyGetProxy ()
 Get the proxy at the current iterator location. More...
 
virtual void SetMode (int)
 The traversal mode for the iterator. More...
 
virtual int GetMode ()
 The traversal mode for the iterator. More...
 
void SetModeToGroupsOnly ()
 The traversal mode for the iterator. More...
 
void SetModeToOneGroup ()
 The traversal mode for the iterator. More...
 
void SetModeToAll ()
 The traversal mode for the iterator. More...
 
virtual void SetSkipPrototypes (bool)
 When set to true (default), the iterator will skip prototype proxies. More...
 
virtual bool GetSkipPrototypes ()
 When set to true (default), the iterator will skip prototype proxies. More...
 
virtual void SkipPrototypesOn ()
 When set to true (default), the iterator will skip prototype proxies. More...
 
virtual void SkipPrototypesOff ()
 When set to true (default), the iterator will skip prototype proxies. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

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

Protected Member Functions

 vtkSMProxyIterator ()
 
 ~vtkSMProxyIterator ()
 
void NextInternal ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Protected Attributes

bool SkipPrototypes
 
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 37 of file vtkSMProxyIterator.h.

Member Typedef Documentation

§ Superclass

Definition at line 41 of file vtkSMProxyIterator.h.

Member Enumeration Documentation

§ TraversalMode

Enumerator
GROUPS_ONLY 
ONE_GROUP 
ALL 

Definition at line 113 of file vtkSMProxyIterator.h.

Constructor & Destructor Documentation

§ vtkSMProxyIterator()

vtkSMProxyIterator::vtkSMProxyIterator ( )
protected

§ ~vtkSMProxyIterator()

vtkSMProxyIterator::~vtkSMProxyIterator ( )
protected

Member Function Documentation

§ New()

static vtkSMProxyIterator* vtkSMProxyIterator::New ( )
static

§ GetClassName()

virtual const char* vtkSMProxyIterator::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMObject.

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetSessionProxyManager()

void vtkSMProxyIterator::SetSessionProxyManager ( vtkSMSessionProxyManager )

Override the set sesssion so the SessionProxyManager could be cache for.

§ SetSession()

void vtkSMProxyIterator::SetSession ( vtkSMSession session)

Convenience method.

Internally calls this->SetSessionProxyManager(session->GetSessionProxyManager());

§ Begin() [1/2]

void vtkSMProxyIterator::Begin ( )

Go to the beginning of the collection.

§ Begin() [2/2]

void vtkSMProxyIterator::Begin ( const char *  groupName)

Go to the beginning of one group, and set mode to iterate over one group.

§ IsAtEnd()

int vtkSMProxyIterator::IsAtEnd ( )

Is the iterator pointing past the last element?

§ Next()

void vtkSMProxyIterator::Next ( )

Move to the next property.

§ GetGroup()

const char* vtkSMProxyIterator::GetGroup ( )

Get the group at the current iterator location.

§ GetKey()

const char* vtkSMProxyIterator::GetKey ( )

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

§ GetProxy()

vtkSMProxy* vtkSMProxyIterator::GetProxy ( )

Get the proxy at the current iterator location.

§ SetMode()

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.

§ GetMode()

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.

§ SetModeToGroupsOnly()

void vtkSMProxyIterator::SetModeToGroupsOnly ( )
inline

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.

Definition at line 99 of file vtkSMProxyIterator.h.

§ SetModeToOneGroup()

void vtkSMProxyIterator::SetModeToOneGroup ( )
inline

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.

Definition at line 100 of file vtkSMProxyIterator.h.

§ SetModeToAll()

void vtkSMProxyIterator::SetModeToAll ( )
inline

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.

Definition at line 101 of file vtkSMProxyIterator.h.

§ SetSkipPrototypes()

virtual void vtkSMProxyIterator::SetSkipPrototypes ( bool  )
virtual

When set to true (default), the iterator will skip prototype proxies.

§ GetSkipPrototypes()

virtual bool vtkSMProxyIterator::GetSkipPrototypes ( )
virtual

When set to true (default), the iterator will skip prototype proxies.

§ SkipPrototypesOn()

virtual void vtkSMProxyIterator::SkipPrototypesOn ( )
virtual

When set to true (default), the iterator will skip prototype proxies.

§ SkipPrototypesOff()

virtual void vtkSMProxyIterator::SkipPrototypesOff ( )
virtual

When set to true (default), the iterator will skip prototype proxies.

§ NextInternal()

void vtkSMProxyIterator::NextInternal ( )
protected

Member Data Documentation

§ SkipPrototypes

bool vtkSMProxyIterator::SkipPrototypes
protected

Definition at line 124 of file vtkSMProxyIterator.h.

§ Mode

int vtkSMProxyIterator::Mode
protected

Definition at line 125 of file vtkSMProxyIterator.h.


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