VTK
vtkUniformGridAMRDataIterator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkUniformGridAMRDataIterator.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
25 #ifndef vtkUniformGridAMRDataIterator_h
26 #define vtkUniformGridAMRDataIterator_h
27 
28 #include "vtkCommonDataModelModule.h" // For export macro
30 #include "vtkSmartPointer.h" //for member variable Information
31 
32 class vtkInformation;
33 class vtkAMRInformation;
35 class vtkUniformGridAMR;
36 class AMRIndexIterator;
37 
38 class VTKCOMMONDATAMODEL_EXPORT vtkUniformGridAMRDataIterator :
40 {
41 public:
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
53 
54  int HasCurrentMetaData() override { return 1;}
55 
60 
66  unsigned int GetCurrentFlatIndex() override;
67 
71  virtual unsigned int GetCurrentLevel();
72 
77  virtual unsigned int GetCurrentIndex();
78 
82  void GoToFirstItem() override;
83 
87  void GoToNextItem() override;
88 
95  int IsDoneWithTraversal() override;
96 
97 protected:
101 private:
103  void operator=(const vtkUniformGridAMRDataIterator&) = delete;
104 
107  vtkAMRInformation* AMRInfo;
108  vtkAMRDataInternals* AMRData;
109 
110  void GetCurrentIndexPair(unsigned int& level, unsigned int& id);
111 
112 };
113 
114 #endif
vtkCompositeDataIterator::GoToFirstItem
virtual void GoToFirstItem()=0
Move the iterator to the beginning of the collection.
vtkAMRInformation
Meta data that describes the structure of an AMR data set.
Definition: vtkAMRInformation.h:48
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkCompositeDataIterator.h
vtkSmartPointer< AMRIndexIterator >
vtkCompositeDataIterator::GetCurrentDataObject
virtual vtkDataObject * GetCurrentDataObject()=0
Returns the current item.
vtkX3D::level
Definition: vtkX3D.h:395
vtkUniformGridAMRDataIterator
subclass of vtkCompositeDataIterator with API to get current level and dataset index.
Definition: vtkUniformGridAMRDataIterator.h:38
vtkUniformGridAMRDataIterator::HasCurrentMetaData
int HasCurrentMetaData() override
Returns if the a meta-data information object is present for the current item.
Definition: vtkUniformGridAMRDataIterator.h:54
vtkCompositeDataIterator::IsDoneWithTraversal
virtual int IsDoneWithTraversal()=0
Test whether the iterator is finished with the traversal.
vtkUniformGridAMRDataIterator::Iter
vtkSmartPointer< AMRIndexIterator > Iter
Definition: vtkUniformGridAMRDataIterator.h:100
vtkCompositeDataIterator
superclass for composite data iterators
Definition: vtkCompositeDataIterator.h:38
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkSmartPointer.h
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkCompositeDataIterator::GetCurrentMetaData
virtual vtkInformation * GetCurrentMetaData()=0
Returns the meta-data associated with the current item.
vtkCompositeDataIterator::GetCurrentFlatIndex
virtual unsigned int GetCurrentFlatIndex()=0
Flat index is an index to identify the data in a composite data structure.
vtkCompositeDataIterator::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkUniformGridAMR
Definition: vtkUniformGridAMR.h:33
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkAMRDataInternals
container of vtkUniformGrid for an AMR data set
Definition: vtkAMRDataInternals.h:35
vtkCompositeDataIterator::GoToNextItem
virtual void GoToNextItem()=0
Move the iterator to the next item in the collection.