VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkUniformGridAMRDataIterator Class Reference

subclass of vtkCompositeDataIterator with API to get current level and dataset index. More...

#include <vtkUniformGridAMRDataIterator.h>

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

Public Types

typedef vtkCompositeDataIterator Superclass
 
- Public Types inherited from vtkCompositeDataIterator
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkUniformGridAMRDataIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkInformationGetCurrentMetaData ()
 
virtual int HasCurrentMetaData ()
 
virtual vtkDataObjectGetCurrentDataObject ()
 
unsigned int GetCurrentFlatIndex ()
 
virtual unsigned int GetCurrentLevel ()
 
virtual unsigned int GetCurrentIndex ()
 
virtual void GoToFirstItem ()
 
virtual void GoToNextItem ()
 
virtual int IsDoneWithTraversal ()
 
- Public Member Functions inherited from vtkCompositeDataIterator
vtkCompositeDataIteratorNewInstance () const
 
virtual void InitTraversal ()
 
virtual void InitReverseTraversal ()
 
virtual void SetDataSet (vtkCompositeDataSet *ds)
 
virtual vtkCompositeDataSetGetDataSet ()
 
virtual void SetSkipEmptyNodes (int)
 
virtual int GetSkipEmptyNodes ()
 
virtual void SkipEmptyNodesOn ()
 
virtual void SkipEmptyNodesOff ()
 
virtual int GetReverse ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
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 *)
 
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 vtkUniformGridAMRDataIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkUniformGridAMRDataIteratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCompositeDataIterator
static int IsTypeOf (const char *type)
 
static vtkCompositeDataIteratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkUniformGridAMRDataIterator ()
 
 ~vtkUniformGridAMRDataIterator ()
 
- Protected Member Functions inherited from vtkCompositeDataIterator
 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

vtkSmartPointer< AMRIndexIterator > Iter
 
- Protected Attributes inherited from vtkCompositeDataIterator
int SkipEmptyNodes
 
int Reverse
 
vtkCompositeDataSetDataSet
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

subclass of vtkCompositeDataIterator with API to get current level and dataset index.

Tests:
vtkUniformGridAMRDataIterator (Tests)

Definition at line 37 of file vtkUniformGridAMRDataIterator.h.

Member Typedef Documentation

Definition at line 42 of file vtkUniformGridAMRDataIterator.h.

Constructor & Destructor Documentation

vtkUniformGridAMRDataIterator::vtkUniformGridAMRDataIterator ( )
protected
vtkUniformGridAMRDataIterator::~vtkUniformGridAMRDataIterator ( )
protected

Member Function Documentation

static vtkUniformGridAMRDataIterator* vtkUniformGridAMRDataIterator::New ( )
static
static int vtkUniformGridAMRDataIterator::IsTypeOf ( const char *  type)
static
virtual int vtkUniformGridAMRDataIterator::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 vtkCompositeDataIterator.

Reimplemented in vtkHierarchicalBoxDataIterator.

static vtkUniformGridAMRDataIterator* vtkUniformGridAMRDataIterator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkUniformGridAMRDataIterator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCompositeDataIterator.

Reimplemented in vtkHierarchicalBoxDataIterator.

vtkUniformGridAMRDataIterator* vtkUniformGridAMRDataIterator::NewInstance ( ) const
void vtkUniformGridAMRDataIterator::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 vtkCompositeDataIterator.

virtual vtkInformation* vtkUniformGridAMRDataIterator::GetCurrentMetaData ( )
virtual

Returns the meta-data associated with the current item. Note that this points to a single instance of vtkInformation object allocated by the iterator and will be changed as soon as GoToNextItem is called.

Implements vtkCompositeDataIterator.

virtual int vtkUniformGridAMRDataIterator::HasCurrentMetaData ( )
inlinevirtual

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

Implements vtkCompositeDataIterator.

Definition at line 51 of file vtkUniformGridAMRDataIterator.h.

virtual vtkDataObject* vtkUniformGridAMRDataIterator::GetCurrentDataObject ( )
virtual

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

Implements vtkCompositeDataIterator.

unsigned int vtkUniformGridAMRDataIterator::GetCurrentFlatIndex ( )
virtual

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.

Implements vtkCompositeDataIterator.

virtual unsigned int vtkUniformGridAMRDataIterator::GetCurrentLevel ( )
virtual

Returns the level for the current dataset.

virtual unsigned int vtkUniformGridAMRDataIterator::GetCurrentIndex ( )
virtual

Returns the dataset index for the current data object. Valid only if the current data is a leaf node i.e. no a composite dataset.

virtual void vtkUniformGridAMRDataIterator::GoToFirstItem ( )
virtual

Move the iterator to the beginning of the collection.

Implements vtkCompositeDataIterator.

virtual void vtkUniformGridAMRDataIterator::GoToNextItem ( )
virtual

Move the iterator to the next item in the collection.

Implements vtkCompositeDataIterator.

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

Implements vtkCompositeDataIterator.

Member Data Documentation

vtkSmartPointer<AMRIndexIterator> vtkUniformGridAMRDataIterator::Iter
protected

Definition at line 85 of file vtkUniformGridAMRDataIterator.h.


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