iterates over the properties of a proxy More...

#include <vtkSMOrderedPropertyIterator.h>

Inheritance diagram for vtkSMOrderedPropertyIterator:

Collaboration diagram for vtkSMOrderedPropertyIterator:

[legend]

Public Types
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	SetProxy (vtkSMProxy *proxy)
	Set the proxy to be used. More...

void	Begin ()
	Go to the first property. More...

int	IsAtEnd ()
	Returns true if iterator points past the end of the collection. More...

void	Next ()
	Move to the next property. More...

const char *	GetKey ()
	Returns the key (name) at the current iterator position. More...

vtkSMProperty *	GetProperty ()
	Returns the property at the current iterator position. More...

const char *	GetPropertyLabel ()
	Returns the XMLLabel for self properties and the exposed name for sub-proxy properties. More...


virtual vtkSMProxy *	GetProxy ()
	Return the proxy. 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 vtkSMOrderedPropertyIterator *	New ()

static int	IsTypeOf (const char *type)

static vtkSMOrderedPropertyIterator *	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
	vtkSMOrderedPropertyIterator ()

	~vtkSMOrderedPropertyIterator () override

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
vtkSMProxy *	Proxy

unsigned int	Index

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

iterates over the properties of a proxy

vtkSMOrderedPropertyIterator is used to iterate over the properties of a proxy. The properties of the root proxies as well as sub-proxies are included in the iteration. For sub-proxies, only exposed properties are iterated over. vtkSMOrderedPropertyIterator iterates over properties in the order they appear in the xml or in the order they were added. This is possible because vtkSMProxy keeps track of the order in which properties were added or exposed in a PropertyNamesInOrder vector.

Definition at line 25 of file vtkSMOrderedPropertyIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMOrderedPropertyIterator::Superclass

Definition at line 29 of file vtkSMOrderedPropertyIterator.h.

Constructor & Destructor Documentation

◆ vtkSMOrderedPropertyIterator()

vtkSMOrderedPropertyIterator::vtkSMOrderedPropertyIterator ( )

protected

◆ ~vtkSMOrderedPropertyIterator()

vtkSMOrderedPropertyIterator::~vtkSMOrderedPropertyIterator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMOrderedPropertyIterator* vtkSMOrderedPropertyIterator::New ( )

static

◆ GetClassName()

virtual const char* vtkSMOrderedPropertyIterator::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMObject.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

◆ SetProxy()

void vtkSMOrderedPropertyIterator::SetProxy ( vtkSMProxy * proxy )

Set the proxy to be used.

◆ GetProxy()

virtual vtkSMProxy* vtkSMOrderedPropertyIterator::GetProxy ( )

virtual

Return the proxy.

◆ Begin()

void vtkSMOrderedPropertyIterator::Begin ( )

Go to the first property.

◆ IsAtEnd()

int vtkSMOrderedPropertyIterator::IsAtEnd ( )

Returns true if iterator points past the end of the collection.

◆ Next()

void vtkSMOrderedPropertyIterator::Next ( )

Move to the next property.

◆ GetKey()

const char* vtkSMOrderedPropertyIterator::GetKey ( )

Returns the key (name) at the current iterator position.

◆ GetProperty()

vtkSMProperty* vtkSMOrderedPropertyIterator::GetProperty ( )

Returns the property at the current iterator position.

◆ GetPropertyLabel()

const char* vtkSMOrderedPropertyIterator::GetPropertyLabel ( )

Returns the XMLLabel for self properties and the exposed name for sub-proxy properties.

Member Data Documentation

◆ Proxy

vtkSMProxy* vtkSMOrderedPropertyIterator::Proxy

protected

Definition at line 79 of file vtkSMOrderedPropertyIterator.h.

◆ Index

unsigned int vtkSMOrderedPropertyIterator::Index

protected

Definition at line 80 of file vtkSMOrderedPropertyIterator.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMOrderedPropertyIterator()

◆ ~vtkSMOrderedPropertyIterator()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetProxy()

◆ GetProxy()

◆ Begin()

◆ IsAtEnd()

◆ Next()

◆ GetKey()

◆ GetProperty()

◆ GetPropertyLabel()

Member Data Documentation

◆ Proxy

◆ Index