subclass of vtkCompositeDataIterator with API to get current level and dataset index. More...
#include <vtkUniformGridAMRDataIterator.h>
Public Types | |
| typedef vtkCompositeDataIterator | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkUniformGridAMRDataIterator * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual vtkInformation * | GetCurrentMetaData () |
| virtual int | HasCurrentMetaData () |
| virtual vtkDataObject * | GetCurrentDataObject () |
| unsigned int | GetCurrentFlatIndex () |
| virtual unsigned int | GetCurrentLevel () |
| virtual unsigned int | GetCurrentIndex () |
| virtual void | GoToFirstItem () |
| virtual void | GoToNextItem () |
| virtual int | IsDoneWithTraversal () |
Static Public Member Functions | |
| static vtkUniformGridAMRDataIterator * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkUniformGridAMRDataIterator * | SafeDownCast (vtkObjectBase *o) |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkUniformGridAMRDataIterator () | |
| ~vtkUniformGridAMRDataIterator () | |
Protected Attributes | |
| vtkSmartPointer< AMRIndexIterator > | Iter |
Detailed Description
subclass of vtkCompositeDataIterator with API to get current level and dataset index.
Definition at line 37 of file vtkUniformGridAMRDataIterator.h.
Member Typedef Documentation
Reimplemented from vtkCompositeDataIterator.
Reimplemented in vtkHierarchicalBoxDataIterator.
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] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
Reimplemented in vtkHierarchicalBoxDataIterator.
| static int vtkUniformGridAMRDataIterator::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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.
| 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] |
Reimplemented from vtkCompositeDataIterator.
Reimplemented in vtkHierarchicalBoxDataIterator.
| virtual vtkObjectBase* vtkUniformGridAMRDataIterator::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkCompositeDataIterator.
Reimplemented in vtkHierarchicalBoxDataIterator.
Reimplemented from vtkCompositeDataIterator.
Reimplemented in vtkHierarchicalBoxDataIterator.
| 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.
Reimplemented in vtkHierarchicalBoxDataIterator.
| 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 | ( | ) | [inline, virtual] |
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:
- dox/Common/DataModel/vtkUniformGridAMRDataIterator.h
