superclass for composite data iterators More...

#include <vtkCompositeDataIterator.h>

Inheritance diagram for vtkCompositeDataIterator:

Collaboration diagram for vtkCompositeDataIterator:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkCompositeDataIterator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	InitTraversal ()

virtual void	InitReverseTraversal ()

virtual void	GoToFirstItem ()=0

virtual void	GoToNextItem ()=0

virtual int	IsDoneWithTraversal ()=0

virtual vtkDataObject *	GetCurrentDataObject ()=0

virtual vtkInformation *	GetCurrentMetaData ()=0

virtual int	HasCurrentMetaData ()=0

virtual unsigned int	GetCurrentFlatIndex ()=0


virtual void	SetDataSet (vtkCompositeDataSet *ds)

virtual vtkCompositeDataSet *	GetDataSet ()


virtual void	SetSkipEmptyNodes (int)

virtual int	GetSkipEmptyNodes ()

virtual void	SkipEmptyNodesOn ()

virtual void	SkipEmptyNodesOff ()


virtual int	GetReverse ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkCompositeDataIterator *	SafeDownCast (vtkObjectBase *o)

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCompositeDataIterator ()

virtual	~vtkCompositeDataIterator ()

Protected Attributes
int	SkipEmptyNodes

int	Reverse

vtkCompositeDataSet *	DataSet

Detailed Description

superclass for composite data iterators

vtkCompositeDataIterator provides an interface for accessing datasets in a collection (vtkCompositeDataIterator).

Examples:: vtkCompositeDataIterator (Examples)

Tests:: vtkCompositeDataIterator (Tests)

Definition at line 40 of file vtkCompositeDataIterator.h.

Member Typedef Documentation

typedef vtkObject vtkCompositeDataIterator::Superclass

Definition at line 43 of file vtkCompositeDataIterator.h.

Constructor & Destructor Documentation

vtkCompositeDataIterator::vtkCompositeDataIterator ( )

protected

virtual vtkCompositeDataIterator::~vtkCompositeDataIterator ( )

protectedvirtual

Member Function Documentation

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

static

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

virtual

Reimplemented in vtkUniformGridAMRDataIterator.

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

static

virtual vtkObjectBase* vtkCompositeDataIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkUniformGridAMRDataIterator.

vtkCompositeDataIterator* vtkCompositeDataIterator::NewInstance ( ) const

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

virtual void vtkCompositeDataIterator::SetDataSet ( vtkCompositeDataSet * ds )

virtual

Set the composite dataset this iterator is iterating over. Must be set before traversal begins.

virtual vtkCompositeDataSet* vtkCompositeDataIterator::GetDataSet ( )

virtual

Set the composite dataset this iterator is iterating over. Must be set before traversal begins.

virtual void vtkCompositeDataIterator::InitTraversal ( )

virtual

Begin iterating over the composite dataset structure.

virtual void vtkCompositeDataIterator::InitReverseTraversal ( )

virtual

Begin iterating over the composite dataset structure in reverse order.

virtual void vtkCompositeDataIterator::GoToFirstItem ( )

pure virtual

Move the iterator to the beginning of the collection.

Implemented in vtkUniformGridAMRDataIterator.

virtual void vtkCompositeDataIterator::GoToNextItem ( )

pure virtual

Move the iterator to the next item in the collection.

Implemented in vtkUniformGridAMRDataIterator.

virtual int vtkCompositeDataIterator::IsDoneWithTraversal ( )

pure virtual

Test whether the iterator is finished with the traversal. Returns 1 for yes, and 0 for no. It is safe to call any of the GetCurrent...() methods only when IsDoneWithTraversal() returns 0.

Implemented in vtkUniformGridAMRDataIterator.

virtual vtkDataObject* vtkCompositeDataIterator::GetCurrentDataObject ( )

pure virtual

Returns the current item. Valid only when IsDoneWithTraversal() returns 0.

Implemented in vtkUniformGridAMRDataIterator.

virtual vtkInformation* vtkCompositeDataIterator::GetCurrentMetaData ( )

pure virtual

Returns the meta-data associated with the current item. This will allocate a new vtkInformation object is none is already present. Use HasCurrentMetaData to avoid unnecessary creation of vtkInformation objects.

Implemented in vtkUniformGridAMRDataIterator.

virtual int vtkCompositeDataIterator::HasCurrentMetaData ( )

pure virtual

Returns if the a meta-data information object is present for the current item. Return 1 on success, 0 otherwise.

Implemented in vtkUniformGridAMRDataIterator.

virtual void vtkCompositeDataIterator::SetSkipEmptyNodes ( int )

virtual

If SkipEmptyNodes is true, then NULL datasets will be skipped. Default is true.

virtual int vtkCompositeDataIterator::GetSkipEmptyNodes ( )

virtual

If SkipEmptyNodes is true, then NULL datasets will be skipped. Default is true.

virtual void vtkCompositeDataIterator::SkipEmptyNodesOn ( )