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>

Inheritance diagram for vtkPVCompositeDataInformationIterator:
Inheritance graph
[legend]
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) override
 
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...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
- 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)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkPVCompositeDataInformationIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVCompositeDataInformationIteratorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPVCompositeDataInformationIterator ()
 
 ~vtkPVCompositeDataInformationIterator () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
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

unsigned int CurrentFlatIndex
 
vtkPVDataInformationDataInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

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

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkObject.

◆ 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: