VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCompositeDataIterator Class Referenceabstract

superclass for composite data iterators More...

#include <vtkCompositeDataIterator.h>

Inheritance diagram for vtkCompositeDataIterator:
[legend]
Collaboration diagram for vtkCompositeDataIterator:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkCompositeDataIteratorNewInstance () 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 vtkDataObjectGetCurrentDataObject ()=0
 
virtual vtkInformation * GetCurrentMetaData ()=0
 
virtual int HasCurrentMetaData ()=0
 
virtual unsigned int GetCurrentFlatIndex ()=0
 
virtual void SetDataSet (vtkCompositeDataSet *ds)
 
virtual vtkCompositeDataSetGetDataSet ()
 
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 vtkCompositeDataIteratorSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkCompositeDataIterator ()
 
virtual ~vtkCompositeDataIterator ()
 

Protected Attributes

int SkipEmptyNodes
 
int Reverse
 
vtkCompositeDataSetDataSet
 

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

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 ( )
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.

virtual unsigned int vtkCompositeDataIterator::GetCurrentFlatIndex ( )
pure virtual

Flat index is an index to identify the data in a composite data structure

Implemented in vtkUniformGridAMRDataIterator.

virtual int vtkCompositeDataIterator::GetReverse ( )
virtual

Returns if the iteration is in reverse order.

Member Data Documentation

int vtkCompositeDataIterator::SkipEmptyNodes
protected

Definition at line 106 of file vtkCompositeDataIterator.h.

int vtkCompositeDataIterator::Reverse
protected

Definition at line 107 of file vtkCompositeDataIterator.h.

vtkCompositeDataSet* vtkCompositeDataIterator::DataSet
protected

Definition at line 108 of file vtkCompositeDataIterator.h.


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