VTK  9.3.0
vtkCompositeDataSet.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
24 #ifndef vtkCompositeDataSet_h
25 #define vtkCompositeDataSet_h
26 
27 #include "vtkCommonDataModelModule.h" // For export macro
28 #include "vtkDataObject.h"
29 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_3_0
30 
31 #include <vector> // For GetDataSets
32 
33 VTK_ABI_NAMESPACE_BEGIN
35 class vtkCompositeDataSetInternals;
36 class vtkDataSet;
37 class vtkInformation;
40 
41 class VTKCOMMONDATAMODEL_EXPORT vtkCompositeDataSet : public vtkDataObject
42 {
43 public:
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
51 
56  int GetDataObjectType() override { return VTK_COMPOSITE_DATA_SET; }
57 
63  virtual void CopyStructure(vtkCompositeDataSet* input);
64 
71  virtual void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) = 0;
72 
80 
89  virtual vtkDataObject* GetDataSet(unsigned int flatIndex);
90 
95  unsigned long GetActualMemorySize() override;
96 
98 
104 
108  void Initialize() override;
109 
118 
122  VTK_DEPRECATED_IN_9_3_0("Use ShallowCopy instead.")
123  virtual void RecursiveShallowCopy(vtkDataObject* src);
124 
130  virtual vtkIdType GetNumberOfPoints();
131 
137  virtual vtkIdType GetNumberOfCells();
138 
142  vtkIdType GetNumberOfElements(int type) override;
143 
153  void GetBounds(double bounds[6]);
154 
158  static vtkInformationStringKey* NAME();
159 
167  static vtkInformationIntegerKey* CURRENT_PROCESS_CAN_LOAD_BLOCK();
168 
179  template <class DataSetT = vtkDataSet>
180  static std::vector<DataSetT*> GetDataSets(vtkDataObject* dobj, bool preserveNull = false);
181 
182 protected:
184  ~vtkCompositeDataSet() override;
185 
186 private:
187  vtkCompositeDataSet(const vtkCompositeDataSet&) = delete;
188  void operator=(const vtkCompositeDataSet&) = delete;
189 };
190 
191 VTK_ABI_NAMESPACE_END
192 #include "vtkCompositeDataSet.txx" // for template implementations
193 
194 #endif
superclass for composite data iterators
abstract superclass for composite (multi-block or AMR) datasets
virtual void SetDataSet(vtkCompositeDataIterator *iter, vtkDataObject *dataObj)=0
Sets the data set at the location pointed by the iterator.
virtual void CompositeShallowCopy(vtkCompositeDataSet *src)
The goal of the method is to copy the data up to the dataset pointers only.
virtual vtkDataObject * GetDataSet(unsigned int flatIndex)
Returns the dataset located at the position pointed by the flatIndex.
static vtkCompositeDataSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
static vtkCompositeDataSet * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
virtual vtkCompositeDataIterator * NewIterator()=0
Return a new iterator (the iterator has to be deleted by user).
virtual void CopyStructure(vtkCompositeDataSet *input)
Copies the tree structure from the input.
virtual vtkDataObject * GetDataSet(vtkCompositeDataIterator *iter)=0
Returns the dataset located at the position pointed by the iterator.
int GetDataObjectType() override
Return class name of data type (see vtkType.h for definitions).
void Initialize() override
Restore data object to initial state,.
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
general representation of visualization data
Definition: vtkDataObject.h:55
abstract class to specify dataset behavior
Definition: vtkDataSet.h:53
a simple class to control print indentation
Definition: vtkIndent.h:29
Key for integer values in vtkInformation.
Key for string values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
void GetBounds(T a, double bds[6])
@ vector
Definition: vtkX3D.h:237
@ info
Definition: vtkX3D.h:376
@ type
Definition: vtkX3D.h:516
#define VTK_DEPRECATED_IN_9_3_0(reason)
int vtkIdType
Definition: vtkType.h:315
#define VTK_COMPOSITE_DATA_SET
Definition: vtkType.h:76
#define VTK_NEWINSTANCE