vtkCompositeDataIterator Class Reference

#include <vtkCompositeDataIterator.h>

Inheritance diagram for vtkCompositeDataIterator:

[legend]Collaboration diagram for vtkCompositeDataIterator:

[legend]List of all members.

---

Detailed Description

abstract superclass for composite data iterators

vtkCompositeDataIterator provides an interface for accessing datasets in a collection (vtkCompositeDataIterator). Sub-classes provide the actual implementation.

Definition at line 30 of file vtkCompositeDataIterator.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 ()
virtual void	GoToFirstItem ()=0
virtual void	GoToNextItem ()=0
virtual int	IsDoneWithTraversal ()=0
virtual vtkDataObject *	GetCurrentDataObject ()=0
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCompositeDataIterator *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkCompositeDataIterator ()
virtual	~vtkCompositeDataIterator ()

---

Member Typedef Documentation

typedef vtkObject vtkCompositeDataIterator::Superclass

Reimplemented from vtkObject. Reimplemented in vtkHierarchicalDataIterator. Definition at line 33 of file vtkCompositeDataIterator.h.

---

Constructor & Destructor Documentation

vtkCompositeDataIterator::vtkCompositeDataIterator (   )  [protected]

virtual vtkCompositeDataIterator::~vtkCompositeDataIterator (   )  [protected, virtual]

---

Member Function Documentation

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

Reimplemented from vtkObject. Reimplemented in vtkHierarchicalDataIterator.

static int vtkCompositeDataIterator::IsTypeOf (  const char *  type  )  [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 vtkHierarchicalDataIterator.

virtual int vtkCompositeDataIterator::IsA (  const char *  type  )  [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 vtkHierarchicalDataIterator.

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

Reimplemented from vtkObject. Reimplemented in vtkHierarchicalDataIterator.

void vtkCompositeDataIterator::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 vtkHierarchicalDataIterator.

void vtkCompositeDataIterator::InitTraversal (   )  [inline]

Move the iterator to the beginning of the collection. Definition at line 37 of file vtkCompositeDataIterator.h.

virtual void vtkCompositeDataIterator::GoToFirstItem (   )  [pure virtual]

Move the iterator to the beginning of the collection. Implemented in vtkHierarchicalDataIterator.

virtual void vtkCompositeDataIterator::GoToNextItem (   )  [pure virtual]

Move the iterator to the next item in the collection. Implemented in vtkHierarchicalDataIterator.

virtual int vtkCompositeDataIterator::IsDoneWithTraversal (   )  [pure virtual]

Test whether the iterator is currently pointing to a valid item. Returns 1 for yes, 0 for no. Implemented in vtkHierarchicalDataIterator.

virtual vtkDataObject* vtkCompositeDataIterator::GetCurrentDataObject (   )  [pure virtual]

Get the current item. Valid only when IsDoneWithTraversal() returns 1. Implemented in vtkHierarchicalDataIterator.

---

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

• dox/Filtering/vtkCompositeDataIterator.h

---