vtkCollectionIterator Class Reference

iterator through a vtkCollection. More...

#include <vtkCollectionIterator.h>

Inheritance diagram for vtkCollectionIterator:

Collaboration diagram for vtkCollectionIterator:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkCollectionIterator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	InitTraversal ()
void	GoToFirstItem ()
void	GoToNextItem ()
int	IsDoneWithTraversal ()
vtkObject *	GetCurrentObject ()
virtual void	SetCollection (vtkCollection *)
virtual vtkCollection *	GetCollection ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
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 *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
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)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCollectionIterator *	SafeDownCast (vtkObjectBase *o)
static vtkCollectionIterator *	New ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCollectionIterator ()
	~vtkCollectionIterator ()
vtkObject *	GetObjectInternal ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
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
vtkCollection *	Collection
vtkCollectionElement *	Element
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

iterator through a vtkCollection.

vtkCollectionIterator provides an alternative way to traverse through the objects in a vtkCollection. Unlike the collection's built in interface, this allows multiple iterators to simultaneously traverse the collection. If items are removed from the collection, only the iterators currently pointing to those items are invalidated. Other iterators will still continue to function normally.

Definition at line 36 of file vtkCollectionIterator.h.

Member Typedef Documentation

typedef vtkObject vtkCollectionIterator::Superclass

Definition at line 39 of file vtkCollectionIterator.h.

Constructor & Destructor Documentation

vtkCollectionIterator::vtkCollectionIterator ( )

protected

vtkCollectionIterator::~vtkCollectionIterator ( )

protected

Member Function Documentation

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

static

virtual int vtkCollectionIterator::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkDataArrayCollectionIterator.

static vtkCollectionIterator* vtkCollectionIterator::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkCollectionIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkDataArrayCollectionIterator.

vtkCollectionIterator* vtkCollectionIterator::NewInstance

(

)

const

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkDataArrayCollectionIterator.

static vtkCollectionIterator* vtkCollectionIterator::New ( )

static

virtual void vtkCollectionIterator::SetCollection ( vtkCollection *  )

virtual

Set/Get the collection over which to iterate.

Reimplemented in vtkDataArrayCollectionIterator.

virtual vtkCollection* vtkCollectionIterator::GetCollection ( )

virtual

Set/Get the collection over which to iterate.

void vtkCollectionIterator::InitTraversal ( )

inline

Position the iterator at the first item in the collection.

Definition at line 50 of file vtkCollectionIterator.h.

void vtkCollectionIterator::GoToFirstItem

(

)

Position the iterator at the first item in the collection.

void vtkCollectionIterator::GoToNextItem

(

)

Move the iterator to the next item in the collection.

int vtkCollectionIterator::IsDoneWithTraversal

(

)

Test whether the iterator is currently positioned at a valid item. Returns 1 for yes, 0 for no.

vtkObject* vtkCollectionIterator::GetCurrentObject

(

)

Get the item at the current iterator position. Valid only when IsDoneWithTraversal() returns 1.

vtkObject* vtkCollectionIterator::GetObjectInternal ( )

protected

Member Data Documentation

vtkCollection* vtkCollectionIterator::Collection

protected

Definition at line 71 of file vtkCollectionIterator.h.

vtkCollectionElement* vtkCollectionIterator::Element

protected

Definition at line 74 of file vtkCollectionIterator.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkCollectionIterator.h