vtkCollectionIterator Class Reference

#include <vtkCollectionIterator.h>

Inheritance diagram for vtkCollectionIterator:

Inheritance graph
[legend]
Collaboration diagram for vtkCollectionIterator:

Collaboration graph
[legend]

List of all members.


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 35 of file vtkCollectionIterator.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void InitTraversal ()
void GoToFirstItem ()
void GoToNextItem ()
int IsDoneWithTraversal ()
vtkObjectGetCurrentObject ()
vtkObjectGetObject ()
virtual void SetCollection (vtkCollection *)
virtual vtkCollectionGetCollection ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkCollectionIteratorSafeDownCast (vtkObject *o)
static vtkCollectionIteratorNew ()

Protected Member Functions

 vtkCollectionIterator ()
 ~vtkCollectionIterator ()
vtkObjectGetObjectInternal ()

Protected Attributes

vtkCollectionCollection
vtkCollectionElementElement

Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkDataArrayCollectionIterator.

Definition at line 38 of file vtkCollectionIterator.h.


Constructor & Destructor Documentation

vtkCollectionIterator::vtkCollectionIterator (  )  [protected]

vtkCollectionIterator::~vtkCollectionIterator (  )  [protected]


Member Function Documentation

virtual const char* vtkCollectionIterator::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkDataArrayCollectionIterator.

static int vtkCollectionIterator::IsTypeOf ( const char *  name  )  [static]

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

Reimplemented from vtkObject.

Reimplemented in vtkDataArrayCollectionIterator.

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkDataArrayCollectionIterator.

static vtkCollectionIterator* vtkCollectionIterator::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

Reimplemented in vtkDataArrayCollectionIterator.

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]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

Reimplemented in vtkDataArrayCollectionIterator.

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 49 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::GetObject (  ) 

vtkObject* vtkCollectionIterator::GetObjectInternal (  )  [protected]


Member Data Documentation

Definition at line 88 of file vtkCollectionIterator.h.

Definition at line 91 of file vtkCollectionIterator.h.


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

Generated on Wed Jun 3 18:57:20 2009 for VTK by  doxygen 1.5.6