vtkSMProxyIterator Class Reference

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

#include <vtkSMProxyIterator.h>

Inheritance diagram for vtkSMProxyIterator:

Collaboration diagram for vtkSMProxyIterator:

List of all members.

Public Types
enum	TraversalMode { GROUPS_ONLY = 0, ONE_GROUP = 1, ALL = 2 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetSession (vtkSMSession *)
void	Begin ()
void	Begin (const char *groupName)
int	IsAtEnd ()
void	Next ()
const char *	GetGroup ()
const char *	GetKey ()
vtkSMProxy *	GetProxy ()
virtual void	SetMode (int)
virtual int	GetMode ()
void	SetModeToGroupsOnly ()
void	SetModeToOneGroup ()
void	SetModeToAll ()
virtual void	SetSkipPrototypes (bool)
virtual bool	GetSkipPrototypes ()
virtual void	SkipPrototypesOn ()
virtual void	SkipPrototypesOff ()
Static Public Member Functions
static vtkSMProxyIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkSMProxyIterator *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMProxyIterator ()
	~vtkSMProxyIterator ()
void	NextInternal ()
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 35 of file vtkSMProxyIterator.h.

---

Member Enumeration Documentation

enum vtkSMProxyIterator::TraversalMode

Enumerator:

GROUPS_ONLY
ONE_GROUP
ALL

Definition at line 87 of file vtkSMProxyIterator.h.

---

Constructor & Destructor Documentation

vtkSMProxyIterator::vtkSMProxyIterator

(

)

[protected]

vtkSMProxyIterator::~vtkSMProxyIterator

(

)

[protected]

---

Member Function Documentation

static vtkSMProxyIterator* vtkSMProxyIterator::New

(

)

[static]

Reimplemented from vtkSMSessionObject.

virtual const char* vtkSMProxyIterator::GetClassName

(

)

[virtual]

Reimplemented from vtkSMSessionObject.

static int vtkSMProxyIterator::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMSessionObject.

virtual int vtkSMProxyIterator::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMSessionObject.

static vtkSMProxyIterator* vtkSMProxyIterator::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMSessionObject.

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

Reimplemented from vtkSMSessionObject.

virtual void vtkSMProxyIterator::SetSession

(

vtkSMSession *

)

[virtual]

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

Reimplemented from vtkSMSessionObject.

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.

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 74 of file vtkSMProxyIterator.h.

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 75 of file vtkSMProxyIterator.h.

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 76 of file vtkSMProxyIterator.h.

virtual void vtkSMProxyIterator::SetSkipPrototypes

(

bool

)

[virtual]

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

virtual bool vtkSMProxyIterator::GetSkipPrototypes

(

)

[virtual]

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

virtual void vtkSMProxyIterator::SkipPrototypesOn

(

)

[virtual]

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

virtual void vtkSMProxyIterator::SkipPrototypesOff

(

)

[virtual]

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

void vtkSMProxyIterator::NextInternal

(

)

[protected]

---

Member Data Documentation

bool vtkSMProxyIterator::SkipPrototypes [protected]

Definition at line 99 of file vtkSMProxyIterator.h.

int vtkSMProxyIterator::Mode [protected]

Definition at line 100 of file vtkSMProxyIterator.h.

---

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

• dox/ParaViewCore/ServerManager/vtkSMProxyIterator.h