vtkSMProxyIterator Class Reference

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

#include <vtkSMProxyIterator.h>

Inheritance diagram for vtkSMProxyIterator:

Collaboration diagram for vtkSMProxyIterator:

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) override
void	SetSessionProxyManager (vtkSMSessionProxyManager *)
	Override the set session 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...
vtkSMProxy *	GetProxy ()
	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 vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkSMProxyIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkSMProxyIterator *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()
static int	IsTypeOf (const char *type)
static vtkSMObject *	SafeDownCast (vtkObject *o)
static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMProxyIterator ()
	~vtkSMProxyIterator () override
void	NextInternal ()
Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()
	~vtkSMObject () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
bool	SkipPrototypes
int	Mode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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

Member Typedef Documentation

Superclass

typedef vtkSMObject vtkSMProxyIterator::Superclass

Definition at line 29 of file vtkSMProxyIterator.h.

Member Enumeration Documentation

TraversalMode

enum vtkSMProxyIterator::TraversalMode

Enumerator
GROUPS_ONLY
ONE_GROUP
ALL

Definition at line 101 of file vtkSMProxyIterator.h.

Constructor & Destructor Documentation

vtkSMProxyIterator()

vtkSMProxyIterator::vtkSMProxyIterator ( )

protected

~vtkSMProxyIterator()

vtkSMProxyIterator::~vtkSMProxyIterator ( )

overrideprotected

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  )

overridevirtual

Reimplemented from vtkSMObject.

SetSessionProxyManager()

void vtkSMProxyIterator::SetSessionProxyManager

(

vtkSMSessionProxyManager *

)

Override the set session 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 87 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 88 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 89 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 112 of file vtkSMProxyIterator.h.

Mode

int vtkSMProxyIterator::Mode

protected

Definition at line 113 of file vtkSMProxyIterator.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMProxyIterator.h