vtkCompositeDataIterator Class Reference

#include <vtkCompositeDataIterator.h>

Inheritance diagram for vtkCompositeDataIterator:

[legend]

Collaboration diagram for vtkCompositeDataIterator:

[legend]

List of all members.

Detailed Description

superclass for composite data iterators

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

Tests:: vtkCompositeDataIterator (Tests)

Definition at line 36 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)
virtual void	InitTraversal ()
virtual void	InitReverseTraversal ()
virtual void	GoToFirstItem ()
virtual void	GoToNextItem ()
virtual int	IsDoneWithTraversal ()
virtual vtkDataObject *	GetCurrentDataObject ()
virtual vtkInformation *	GetCurrentMetaData ()
virtual int	HasCurrentMetaData ()
unsigned int	GetCurrentFlatIndex ()

virtual void	SetDataSet (vtkCompositeDataSet *ds)
virtual vtkCompositeDataSet *	GetDataSet ()

virtual void	SetVisitOnlyLeaves (int)
virtual int	GetVisitOnlyLeaves ()
virtual void	VisitOnlyLeavesOn ()
virtual void	VisitOnlyLeavesOff ()

virtual void	SetTraverseSubTree (int)
virtual int	GetTraverseSubTree ()
virtual void	TraverseSubTreeOn ()
virtual void	TraverseSubTreeOff ()

virtual void	SetSkipEmptyNodes (int)
virtual int	GetSkipEmptyNodes ()
virtual void	SkipEmptyNodesOn ()
virtual void	SkipEmptyNodesOff ()

virtual int	GetReverse ()
Static Public Member Functions
static vtkCompositeDataIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkCompositeDataIterator *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkCompositeDataIterator ()
virtual	~vtkCompositeDataIterator ()
void	NextInternal ()
vtkCompositeDataSetIndex	GetCurrentIndex ()
Protected Attributes
unsigned int	CurrentFlatIndex
int	SkipEmptyNodes
int	TraverseSubTree
int	Reverse
int	VisitOnlyLeaves
vtkCompositeDataSet *	DataSet
Friends
class	vtkCompositeDataSet
class	vtkInternals

Member Typedef Documentation

typedef vtkObject vtkCompositeDataIterator::Superclass

Reimplemented from vtkObject.

Reimplemented in vtkHierarchicalBoxDataIterator.

Definition at line 40 of file vtkCompositeDataIterator.h.

Constructor & Destructor Documentation

vtkCompositeDataIterator::vtkCompositeDataIterator ( ) [protected]

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

Member Function Documentation

static vtkCompositeDataIterator* vtkCompositeDataIterator::New ( ) [static]

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

Reimplemented from vtkObject.

Reimplemented in vtkHierarchicalBoxDataIterator.

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

Reimplemented from vtkObject.

Reimplemented in vtkHierarchicalBoxDataIterator.

static int vtkCompositeDataIterator::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkHierarchicalBoxDataIterator.

virtual int vtkCompositeDataIterator::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkHierarchicalBoxDataIterator.

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

Reimplemented from vtkObject.

Reimplemented in vtkHierarchicalBoxDataIterator.

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 vtkHierarchicalBoxDataIterator.

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 ( ) [virtual]

Move the iterator to the beginning of the collection.

virtual void vtkCompositeDataIterator::GoToNextItem ( ) [virtual]

Move the iterator to the next item in the collection.

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

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

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

virtual vtkInformation* vtkCompositeDataIterator::GetCurrentMetaData ( ) [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.

virtual int vtkCompositeDataIterator::HasCurrentMetaData ( ) [virtual]

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

virtual void vtkCompositeDataIterator::SetVisitOnlyLeaves ( int ) [virtual]

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual int vtkCompositeDataIterator::GetVisitOnlyLeaves ( ) [virtual]

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual void vtkCompositeDataIterator::VisitOnlyLeavesOn ( ) [virtual]

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual void vtkCompositeDataIterator::VisitOnlyLeavesOff ( ) [virtual]

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual void vtkCompositeDataIterator::SetTraverseSubTree ( int ) [virtual]

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

virtual int vtkCompositeDataIterator::GetTraverseSubTree ( ) [virtual]

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

virtual void vtkCompositeDataIterator::TraverseSubTreeOn ( ) [virtual]

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

virtual void vtkCompositeDataIterator::TraverseSubTreeOff ( ) [virtual]

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

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 ( ) [virtual]

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

virtual void vtkCompositeDataIterator::SkipEmptyNodesOff ( ) [virtual]

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

unsigned int vtkCompositeDataIterator::GetCurrentFlatIndex ( )

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.

virtual int vtkCompositeDataIterator::GetReverse ( ) [virtual]

Returns if the iteration is in reverse order.

void vtkCompositeDataIterator::NextInternal ( ) [protected]