ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVCompositeDataInformationIterator Class Reference

iterator used to iterate over data information for a composite data set. More...

#include <vtkPVCompositeDataInformationIterator.h>

Inherits vtkObject.

Collaboration diagram for vtkPVCompositeDataInformationIterator:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void InitTraversal ()
 Initializes the traversal. More...
 
bool IsDoneWithTraversal ()
 Returns true, if the iterator is finished with the traversal. More...
 
void GoToNextItem ()
 Goes to the next node. More...
 
vtkPVDataInformationGetCurrentDataInformation ()
 Returns the current nodes data-information. More...
 
const char * GetCurrentName ()
 Returns the name for the current node. More...
 
void SetDataInformation (vtkPVDataInformation *)
 Get/Set the vtkPVDataInformation instance to iterate over. More...
 
virtual vtkPVDataInformationGetDataInformation ()
 Get/Set the vtkPVDataInformation instance to iterate over. More...
 
virtual unsigned int GetCurrentFlatIndex ()
 Returns the current flat index/composite index. More...
 

Static Public Member Functions

static vtkPVCompositeDataInformationIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVCompositeDataInformationIteratorSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVCompositeDataInformationIterator ()
 
 ~vtkPVCompositeDataInformationIterator ()
 

Protected Attributes

unsigned int CurrentFlatIndex
 
vtkPVDataInformationDataInformation
 

Detailed Description

iterator used to iterate over data information for a composite data set.

vtkPVCompositeDataInformationIterator is an iterator used to iterate over data information for a composite data set.

Definition at line 32 of file vtkPVCompositeDataInformationIterator.h.

Member Typedef Documentation

§ Superclass

Definition at line 36 of file vtkPVCompositeDataInformationIterator.h.

Constructor & Destructor Documentation

§ vtkPVCompositeDataInformationIterator()

vtkPVCompositeDataInformationIterator::vtkPVCompositeDataInformationIterator ( )
protected

§ ~vtkPVCompositeDataInformationIterator()

vtkPVCompositeDataInformationIterator::~vtkPVCompositeDataInformationIterator ( )
protected

Member Function Documentation

§ New()

static vtkPVCompositeDataInformationIterator* vtkPVCompositeDataInformationIterator::New ( )
static

§ GetClassName()

virtual const char* vtkPVCompositeDataInformationIterator::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

static vtkPVCompositeDataInformationIterator* vtkPVCompositeDataInformationIterator::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

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

§ SetDataInformation()

void vtkPVCompositeDataInformationIterator::SetDataInformation ( vtkPVDataInformation )

Get/Set the vtkPVDataInformation instance to iterate over.

It is assumed that the argument represents the data information for a composite dataset.

§ GetDataInformation()

virtual vtkPVDataInformation* vtkPVCompositeDataInformationIterator::GetDataInformation ( )
virtual

Get/Set the vtkPVDataInformation instance to iterate over.

It is assumed that the argument represents the data information for a composite dataset.

§ InitTraversal()

void vtkPVCompositeDataInformationIterator::InitTraversal ( )

Initializes the traversal.

§ IsDoneWithTraversal()

bool vtkPVCompositeDataInformationIterator::IsDoneWithTraversal ( )

Returns true, if the iterator is finished with the traversal.

§ GoToNextItem()

void vtkPVCompositeDataInformationIterator::GoToNextItem ( )

Goes to the next node.

§ GetCurrentDataInformation()

vtkPVDataInformation* vtkPVCompositeDataInformationIterator::GetCurrentDataInformation ( )

Returns the current nodes data-information.

If current node is a piece within a multi-piece dataset, then this will return NULL.

§ GetCurrentName()

const char* vtkPVCompositeDataInformationIterator::GetCurrentName ( )

Returns the name for the current node.

Name may be valid only for a child node. The root node has no name. Returns NULL when no name is provided.

§ GetCurrentFlatIndex()

virtual unsigned int vtkPVCompositeDataInformationIterator::GetCurrentFlatIndex ( )
virtual

Returns the current flat index/composite index.

This is only valid is IsDoneWithTraversal() returns false.

Member Data Documentation

§ CurrentFlatIndex

unsigned int vtkPVCompositeDataInformationIterator::CurrentFlatIndex
protected

Definition at line 87 of file vtkPVCompositeDataInformationIterator.h.

§ DataInformation

vtkPVDataInformation* vtkPVCompositeDataInformationIterator::DataInformation
protected

Definition at line 88 of file vtkPVCompositeDataInformationIterator.h.


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