superclass for composite data iterators More...

#include <vtkCompositeDataIterator.h>

Inheritance diagram for vtkCompositeDataIterator:

Collaboration diagram for vtkCompositeDataIterator:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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

static vtkCompositeDataIterator *	SafeDownCast (vtkObjectBase *o)

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

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCompositeDataIterator ()

virtual	~vtkCompositeDataIterator ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	SkipEmptyNodes

int	Reverse

vtkCompositeDataSet *	DataSet

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

superclass for composite data iterators

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

Tests:: vtkCompositeDataIterator (Tests)

Definition at line 37 of file vtkCompositeDataIterator.h.

Member Typedef Documentation

typedef vtkObject vtkCompositeDataIterator::Superclass

Definition at line 40 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 * 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 vtkDataObjectTreeIterator, vtkUniformGridAMRDataIterator, and vtkHierarchicalBoxDataIterator.

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

static

virtual vtkObjectBase* vtkCompositeDataIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkDataObjectTreeIterator, vtkUniformGridAMRDataIterator, and vtkHierarchicalBoxDataIterator.

vtkCompositeDataIterator* vtkCompositeDataIterator::NewInstance ( ) const

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 vtkDataObjectTreeIterator, vtkUniformGridAMRDataIterator, and 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 ( )

pure virtual

Move the iterator to the beginning of the collection.

Implemented in vtkUniformGridAMRDataIterator, and vtkDataObjectTreeIterator.

virtual void vtkCompositeDataIterator::GoToNextItem ( )

pure virtual

Move the iterator to the next item in the collection.

Implemented in vtkUniformGridAMRDataIterator, and vtkDataObjectTreeIterator.

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, and vtkDataObjectTreeIterator.

virtual vtkDataObject* vtkCompositeDataIterator::GetCurrentDataObject ( )

pure virtual

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

Implemented in vtkDataObjectTreeIterator, and 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 vtkDataObjectTreeIterator, and 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 vtkDataObjectTreeIterator, and 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 ( )