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

#include <vtkPVProxyDefinitionIterator.h>

Inheritance diagram for vtkPVProxyDefinitionIterator:

Collaboration diagram for vtkPVProxyDefinitionIterator:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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 nullptr if Next() was never called. More...

virtual const char *	GetProxyName ()=0
	Return the current proxy name or nullptr if Next() was never called. More...

virtual bool	IsCustom ()
	Return true if the current definition has been defined in the Custom scope. More...

virtual vtkPVXMLElement *	GetProxyDefinition ()=0
	Return the current XML proxy definition. More...

virtual vtkPVXMLElement *	GetProxyHints ()=0
	Return the current XML proxy hints. 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 int	IsTypeOf (const char *type)

static vtkPVProxyDefinitionIterator *	SafeDownCast (vtkObject *o)

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
	vtkPVProxyDefinitionIterator ()

	~vtkPVProxyDefinitionIterator () 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 &)

Additional Inherited Members
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 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 26 of file vtkPVProxyDefinitionIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVProxyDefinitionIterator::Superclass

Definition at line 29 of file vtkPVProxyDefinitionIterator.h.

Constructor & Destructor Documentation

◆ vtkPVProxyDefinitionIterator()

vtkPVProxyDefinitionIterator::vtkPVProxyDefinitionIterator ( )

protected

◆ ~vtkPVProxyDefinitionIterator()

vtkPVProxyDefinitionIterator::~vtkPVProxyDefinitionIterator ( )

overrideprotected

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

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ 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 42 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 nullptr if Next() was never called.

◆ GetProxyName()

virtual const char* vtkPVProxyDefinitionIterator::GetProxyName ( )

pure virtual

Return the current proxy name or nullptr 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 73 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:

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkPVProxyDefinitionIterator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVProxyDefinitionIterator()

◆ ~vtkPVProxyDefinitionIterator()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GoToFirstItem()

◆ InitTraversal()

◆ GoToNextItem()

◆ GoToNextGroup()

◆ IsDoneWithTraversal()

◆ AddTraversalGroupName()

◆ GetGroupName()

◆ GetProxyName()

◆ IsCustom()

◆ GetProxyDefinition()

◆ GetProxyHints()