VTK  9.0.0
vtkCompositeDataIterator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCompositeDataIterator.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 =========================================================================*/
23 #ifndef vtkCompositeDataIterator_h
24 #define vtkCompositeDataIterator_h
25 
26 #include "vtkCommonDataModelModule.h" // For export macro
27 #include "vtkObject.h"
28 
30 class vtkCompositeDataSetInternals;
31 class vtkCompositeDataSetIndex;
32 class vtkDataObject;
33 class vtkInformation;
34 
35 class VTKCOMMONDATAMODEL_EXPORT vtkCompositeDataIterator : public vtkObject
36 {
37 public:
39  void PrintSelf(ostream& os, vtkIndent indent) override;
40 
42 
46  virtual void SetDataSet(vtkCompositeDataSet* ds);
47  vtkGetObjectMacro(DataSet, vtkCompositeDataSet);
49 
53  virtual void InitTraversal();
54 
58  virtual void InitReverseTraversal();
59 
63  virtual void GoToFirstItem() = 0;
64 
68  virtual void GoToNextItem() = 0;
69 
76  virtual int IsDoneWithTraversal() = 0;
77 
81  virtual vtkDataObject* GetCurrentDataObject() = 0;
82 
88  virtual vtkInformation* GetCurrentMetaData() = 0;
89 
94  virtual int HasCurrentMetaData() = 0;
95 
97 
101  vtkSetMacro(SkipEmptyNodes, vtkTypeBool);
102  vtkGetMacro(SkipEmptyNodes, vtkTypeBool);
103  vtkBooleanMacro(SkipEmptyNodes, vtkTypeBool);
105 
109  virtual unsigned int GetCurrentFlatIndex() = 0;
110 
112 
115  vtkGetMacro(Reverse, int);
117 
118 protected:
120  ~vtkCompositeDataIterator() override;
121 
122  // Use macro to ensure MTime is updated:
123  vtkSetMacro(Reverse, int);
124 
126  int Reverse;
128 
129 private:
131  void operator=(const vtkCompositeDataIterator&) = delete;
132 };
133 
134 #endif
vtx::types::DataSet
std::map< std::string, DataArray > DataSet
key: variable name, value: DataArray
Definition: VTXTypes.h:39
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkCompositeDataSet
abstract superclass for composite (multi-block or AMR) datasets
Definition: vtkCompositeDataSet.h:45
vtkCompositeDataIterator
superclass for composite data iterators
Definition: vtkCompositeDataIterator.h:35
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkObject.h
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkCompositeDataIterator::SkipEmptyNodes
vtkTypeBool SkipEmptyNodes
Definition: vtkCompositeDataIterator.h:123
vtkCompositeDataIterator::DataSet
vtkCompositeDataSet * DataSet
Definition: vtkCompositeDataIterator.h:127
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:59
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkCompositeDataIterator::Reverse
int Reverse
Definition: vtkCompositeDataIterator.h:126