vtkHierarchicalDataIterator Class Reference

#include <vtkHierarchicalDataIterator.h>

Inheritance diagram for vtkHierarchicalDataIterator:

[legend]Collaboration diagram for vtkHierarchicalDataIterator:

[legend]List of all members.

Detailed Description

iterator to access datasets in a vtkHierarchicalDataIterator

vtkMultiBlockDataIterator is a concrete implementation of vtkCompositeDataIterator for vtkMultiBlockDataSet. It allows flat and forward access to the datasets in the hierchical dataset.

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (81%)
Geveci, Berk (18%)

CVS logs (CVSweb):

.cxx (/Filtering/vtkHierarchicalDataIterator.cxx)
.h (/Filtering/vtkHierarchicalDataIterator.h)

Definition at line 42 of file vtkHierarchicalDataIterator.h.

Public Types

typedef vtkCompositeDataIterator Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

virtual void GoToFirstItem ()

virtual void GoToNextItem ()

virtual int IsDoneWithTraversal ()

virtual vtkDataObject * GetCurrentDataObject ()

void SetDataSet (vtkHierarchicalDataSet *dataset)

virtual vtkHierarchicalDataSet * GetDataSet ()

Static Public Member Functions

vtkHierarchicalDataIterator * New ()

int IsTypeOf (const char *type)

vtkHierarchicalDataIterator * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkHierarchicalDataIterator ()

virtual ~vtkHierarchicalDataIterator ()

void GoToNextNonEmptyLevel ()

Protected Attributes

vtkHierarchicalDataSet * DataSet

vtkHierarchicalDataIteratorInternal * Internal

Member Typedef Documentation

typedef vtkCompositeDataIterator vtkHierarchicalDataIterator::Superclass

Reimplemented from vtkCompositeDataIterator.
Definition at line 47 of file vtkHierarchicalDataIterator.h.

Constructor & Destructor Documentation

vtkHierarchicalDataIterator::vtkHierarchicalDataIterator ( ) [protected]

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

Member Function Documentation

vtkHierarchicalDataIterator* vtkHierarchicalDataIterator::New ( ) [static]

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

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

Reimplemented from vtkCompositeDataIterator.

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

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

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

Reimplemented from vtkCompositeDataIterator.

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

virtual void vtkHierarchicalDataIterator::GoToFirstItem ( ) [virtual]

Move the iterator to the beginning of the collection.
Implements vtkCompositeDataIterator.

virtual void vtkHierarchicalDataIterator::GoToNextItem ( ) [virtual]

Move the iterator to the next item in the collection.
Implements vtkCompositeDataIterator.

virtual int vtkHierarchicalDataIterator::IsDoneWithTraversal ( ) [virtual]

Test whether the iterator is currently pointing to a valid item. Returns 1 for yes, 0 for no.
Implements vtkCompositeDataIterator.

virtual vtkDataObject* vtkHierarchicalDataIterator::GetCurrentDataObject ( ) [virtual]

Get the current item. Valid only when IsDoneWithTraversal() returns 1.
Implements vtkCompositeDataIterator.

void vtkHierarchicalDataIterator::SetDataSet ( vtkHierarchicalDataSet * dataset )

Set the data object to iterator over.

virtual vtkHierarchicalDataSet* vtkHierarchicalDataIterator::GetDataSet ( ) [virtual]

Set the data object to iterator over.

void vtkHierarchicalDataIterator::GoToNextNonEmptyLevel ( ) [protected]

Member Data Documentation

vtkHierarchicalDataSet* vtkHierarchicalDataIterator::DataSet [protected]

Definition at line 76 of file vtkHierarchicalDataIterator.h.

vtkHierarchicalDataIteratorInternal* vtkHierarchicalDataIterator::Internal [protected]

Definition at line 77 of file vtkHierarchicalDataIterator.h.

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

dox/Filtering/vtkHierarchicalDataIterator.h


Public Types
typedef vtkCompositeDataIterator	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	GoToFirstItem ()
virtual void	GoToNextItem ()
virtual int	IsDoneWithTraversal ()
virtual vtkDataObject *	GetCurrentDataObject ()

void	SetDataSet (vtkHierarchicalDataSet *dataset)
virtual vtkHierarchicalDataSet *	GetDataSet ()
Static Public Member Functions
vtkHierarchicalDataIterator *	New ()
int	IsTypeOf (const char *type)
vtkHierarchicalDataIterator *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkHierarchicalDataIterator ()
virtual	~vtkHierarchicalDataIterator ()
void	GoToNextNonEmptyLevel ()
Protected Attributes
vtkHierarchicalDataSet *	DataSet
vtkHierarchicalDataIteratorInternal *	Internal