iterates over a subset of a proxy's properties More...

#include <vtkSMNamedPropertyIterator.h>

Inheritance diagram for vtkSMNamedPropertyIterator:

Collaboration diagram for vtkSMNamedPropertyIterator:

[legend]

Public Types
typedef vtkSMPropertyIterator	Superclass

Public Types inherited from vtkSMPropertyIterator
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	Begin () override
	Go to the first property. More...

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

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

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

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

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


void	SetPropertyNames (vtkStringList *names)
	Set the names of properties to iterate over. More...

void	SetPropertyNames (const std::vector< std::string > &names)
	Set the names of properties to iterate over. More...

Public Member Functions inherited from vtkSMPropertyIterator
void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetProxy (vtkSMProxy *proxy)
	Set the proxy to be used. More...

virtual vtkSMProxy *	GetProxy ()
	Return the proxy. More...

virtual void	SetTraverseSubProxies (int)
	If TraverseSubProxies is false, only the properties belonging to the root proxy are returned. More...

virtual int	GetTraverseSubProxies ()
	If TraverseSubProxies is false, only the properties belonging to the root proxy are returned. 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 vtkSMNamedPropertyIterator *	New ()

static int	IsTypeOf (const char *type)

static vtkSMNamedPropertyIterator *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMPropertyIterator
static vtkSMPropertyIterator *	New ()

static int	IsTypeOf (const char *type)

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

	~vtkSMNamedPropertyIterator () override

Protected Member Functions inherited from vtkSMPropertyIterator
	vtkSMPropertyIterator ()

	~vtkSMPropertyIterator () 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
vtkStringList *	PropertyNames

int	PropertyNameIndex

Protected Attributes inherited from vtkSMPropertyIterator
vtkSMProxy *	Proxy

int	TraverseSubProxies

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

iterates over a subset of a proxy's properties

vtkSMNamedPropertyIterator can be used to iterate over a subset of a proxy's properties. The subset is defined through a list of strings naming properties. 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.

See also: vtkSMPropertyIterator

Thanks:: This class was contributed by SciberQuest Inc.

Definition at line 33 of file vtkSMNamedPropertyIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMPropertyIterator vtkSMNamedPropertyIterator::Superclass

Definition at line 37 of file vtkSMNamedPropertyIterator.h.

Constructor & Destructor Documentation

◆ vtkSMNamedPropertyIterator()

vtkSMNamedPropertyIterator::vtkSMNamedPropertyIterator ( )

protected

◆ ~vtkSMNamedPropertyIterator()

vtkSMNamedPropertyIterator::~vtkSMNamedPropertyIterator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMNamedPropertyIterator* vtkSMNamedPropertyIterator::New ( )

static

◆ GetClassName()

virtual const char* vtkSMNamedPropertyIterator::GetClassName ( )

virtual

Reimplemented from vtkSMPropertyIterator.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMPropertyIterator.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ SetPropertyNames() [1/2]

void vtkSMNamedPropertyIterator::SetPropertyNames ( vtkStringList * names )

Set the names of properties to iterate over.

◆ SetPropertyNames() [2/2]

void vtkSMNamedPropertyIterator::SetPropertyNames ( const std::vector< std::string > & names )

Set the names of properties to iterate over.

◆ Begin()

void vtkSMNamedPropertyIterator::Begin ( )

overridevirtual

Go to the first property.

Reimplemented from vtkSMPropertyIterator.

◆ IsAtEnd()

int vtkSMNamedPropertyIterator::IsAtEnd ( )

overridevirtual

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

Reimplemented from vtkSMPropertyIterator.

◆ Next()

void vtkSMNamedPropertyIterator::Next ( )

overridevirtual

Move to the next property.

Reimplemented from vtkSMPropertyIterator.

◆ GetKey()

const char* vtkSMNamedPropertyIterator::GetKey ( )

overridevirtual

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

Reimplemented from vtkSMPropertyIterator.

◆ GetPropertyLabel()

const char* vtkSMNamedPropertyIterator::GetPropertyLabel ( )

overridevirtual

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

Reimplemented from vtkSMPropertyIterator.

◆ GetProperty()

vtkSMProperty* vtkSMNamedPropertyIterator::GetProperty ( )

overridevirtual

Returns the property at the current iterator position.

Reimplemented from vtkSMPropertyIterator.

Member Data Documentation

◆ PropertyNames

vtkStringList* vtkSMNamedPropertyIterator::PropertyNames

protected

Definition at line 83 of file vtkSMNamedPropertyIterator.h.

◆ PropertyNameIndex

int vtkSMNamedPropertyIterator::PropertyNameIndex

protected

Definition at line 84 of file vtkSMNamedPropertyIterator.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMNamedPropertyIterator()

◆ ~vtkSMNamedPropertyIterator()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetPropertyNames() [1/2]

◆ SetPropertyNames() [2/2]

◆ Begin()

◆ IsAtEnd()

◆ Next()

◆ GetKey()

◆ GetPropertyLabel()

◆ GetProperty()

Member Data Documentation

◆ PropertyNames

◆ PropertyNameIndex