vtkUniformGridAMRDataIterator Class Reference

subclass of vtkCompositeDataIterator with API to get current level and dataset index. More...

#include <vtkUniformGridAMRDataIterator.h>

Inheritance diagram for vtkUniformGridAMRDataIterator:

Collaboration diagram for vtkUniformGridAMRDataIterator:

Public Types
typedef vtkCompositeDataIterator	Superclass
Public Types inherited from vtkCompositeDataIterator
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkUniformGridAMRDataIterator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkInformation *	GetCurrentMetaData ()
virtual int	HasCurrentMetaData ()
virtual vtkDataObject *	GetCurrentDataObject ()
unsigned int	GetCurrentFlatIndex ()
virtual unsigned int	GetCurrentLevel ()
virtual unsigned int	GetCurrentIndex ()
virtual void	GoToFirstItem ()
virtual void	GoToNextItem ()
virtual int	IsDoneWithTraversal ()
Public Member Functions inherited from vtkCompositeDataIterator
vtkCompositeDataIterator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	InitTraversal ()
virtual void	InitReverseTraversal ()
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 vtkUniformGridAMRDataIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkUniformGridAMRDataIterator *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkCompositeDataIterator
static int	IsTypeOf (const char *type)
static vtkCompositeDataIterator *	SafeDownCast (vtkObjectBase *o)

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkUniformGridAMRDataIterator ()
	~vtkUniformGridAMRDataIterator ()
Protected Member Functions inherited from vtkCompositeDataIterator
	vtkCompositeDataIterator ()
virtual	~vtkCompositeDataIterator ()

Protected Attributes
vtkSmartPointer< AMRIndexIterator >	Iter
Protected Attributes inherited from vtkCompositeDataIterator
int	SkipEmptyNodes
int	Reverse
vtkCompositeDataSet *	DataSet

Detailed Description

subclass of vtkCompositeDataIterator with API to get current level and dataset index.

Tests:

vtkUniformGridAMRDataIterator (Tests)

Definition at line 37 of file vtkUniformGridAMRDataIterator.h.

Member Typedef Documentation

typedef vtkCompositeDataIterator vtkUniformGridAMRDataIterator::Superclass

Definition at line 42 of file vtkUniformGridAMRDataIterator.h.

Constructor & Destructor Documentation

vtkUniformGridAMRDataIterator::vtkUniformGridAMRDataIterator ( )

protected

vtkUniformGridAMRDataIterator::~vtkUniformGridAMRDataIterator ( )

protected

Member Function Documentation

static vtkUniformGridAMRDataIterator* vtkUniformGridAMRDataIterator::New ( )

static

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

static

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

virtual

Reimplemented from vtkCompositeDataIterator.

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

static

virtual vtkObjectBase* vtkUniformGridAMRDataIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCompositeDataIterator.

vtkUniformGridAMRDataIterator* vtkUniformGridAMRDataIterator::NewInstance

(

)

const

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

virtual vtkInformation* vtkUniformGridAMRDataIterator::GetCurrentMetaData ( )

virtual

Returns the meta-data associated with the current item. Note that this points to a single instance of vtkInformation object allocated by the iterator and will be changed as soon as GoToNextItem is called.

Implements vtkCompositeDataIterator.

virtual int vtkUniformGridAMRDataIterator::HasCurrentMetaData ( )

inlinevirtual

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

Implements vtkCompositeDataIterator.

Definition at line 51 of file vtkUniformGridAMRDataIterator.h.

virtual vtkDataObject* vtkUniformGridAMRDataIterator::GetCurrentDataObject ( )

virtual

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

Implements vtkCompositeDataIterator.

unsigned int vtkUniformGridAMRDataIterator::GetCurrentFlatIndex ( )

virtual

Flat index is an index obtained by traversing the tree in preorder. This can be used to uniquely identify nodes in the tree. Not valid if IsDoneWithTraversal() returns true.

Implements vtkCompositeDataIterator.

virtual unsigned int vtkUniformGridAMRDataIterator::GetCurrentLevel ( )

virtual

Returns the level for the current dataset.

virtual unsigned int vtkUniformGridAMRDataIterator::GetCurrentIndex ( )

virtual

Returns the dataset index for the current data object. Valid only if the current data is a leaf node i.e. no a composite dataset.

virtual void vtkUniformGridAMRDataIterator::GoToFirstItem ( )

virtual

Move the iterator to the beginning of the collection.

Implements vtkCompositeDataIterator.

virtual void vtkUniformGridAMRDataIterator::GoToNextItem ( )

virtual

Move the iterator to the next item in the collection.

Implements vtkCompositeDataIterator.

virtual int vtkUniformGridAMRDataIterator::IsDoneWithTraversal ( )

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.

Implements vtkCompositeDataIterator.

Member Data Documentation

vtkSmartPointer<AMRIndexIterator> vtkUniformGridAMRDataIterator::Iter

protected

Definition at line 85 of file vtkUniformGridAMRDataIterator.h.

---

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

• dox/Common/DataModel/vtkUniformGridAMRDataIterator.h