VTK  9.3.20240328
vtkDataObjectTree.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
43 #ifndef vtkDataObjectTree_h
44 #define vtkDataObjectTree_h
45 
46 #include "vtkCommonDataModelModule.h" // For export macro
47 #include "vtkCompositeDataSet.h"
48 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_3_0
49 
50 VTK_ABI_NAMESPACE_BEGIN
54 class vtkInformation;
56 class vtkDataObject;
57 
58 class VTKCOMMONDATAMODEL_EXPORT vtkDataObjectTree : public vtkCompositeDataSet
59 {
60 public:
62  void PrintSelf(ostream& os, vtkIndent indent) override;
63 
68 
77 
83  void CopyStructure(vtkCompositeDataSet* input) override;
84 
91  void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) override;
92 
97 
98  // Needed because, otherwise vtkCompositeData::GetDataSet(unsigned int flatIndex) is hidden.
99  using Superclass::GetDataSet;
107 
117 
125 
130  unsigned long GetActualMemorySize() override;
131 
135  void Initialize() override;
136 
138 
142  void ShallowCopy(vtkDataObject* src) override;
143  void DeepCopy(vtkDataObject* src) override;
145 
149  VTK_DEPRECATED_IN_9_3_0("Please use ShallowCopy instead.")
150  void RecursiveShallowCopy(vtkDataObject* src) override;
151 
157  vtkIdType GetNumberOfPoints() override;
158 
164  vtkIdType GetNumberOfCells() override;
165 
169  unsigned int GetNumberOfChildren();
170 
174  vtkDataObject* GetChild(unsigned int index);
175 
181  vtkInformation* GetChildMetaData(unsigned int index);
182 
187  vtkTypeBool HasChildMetaData(unsigned int index);
188 
190 
196 
200  int GetDataObjectType() override { return VTK_DATA_OBJECT_TREE; }
201 
202 protected:
204  ~vtkDataObjectTree() override;
205 
209  void SetNumberOfChildren(unsigned int num);
210 
215  void SetChild(unsigned int index, vtkDataObject*);
216 
220  void RemoveChild(unsigned int index);
221 
226 
234 
235  // The internal datastructure. Subclasses need not access this directly.
237 
239 
240 private:
241  vtkDataObjectTree(const vtkDataObjectTree&) = delete;
242  void operator=(const vtkDataObjectTree&) = delete;
243 };
244 
245 VTK_ABI_NAMESPACE_END
246 #endif
superclass for composite data iterators
abstract superclass for composite (multi-block or AMR) datasets
superclass for composite data iterators
provides implementation for most abstract methods in the superclass vtkCompositeDataSet
virtual vtkDataObjectTree * CreateForCopyStructure(vtkDataObjectTree *other)
When copying structure from another vtkDataObjectTree, this method gets called for create a new non-l...
void SetChildMetaData(unsigned int index, vtkInformation *info)
Sets the meta-data at a given index.
virtual vtkInformation * GetMetaData(vtkCompositeDataIterator *iter)
Returns the meta-data associated with the position pointed by the iterator.
void SetDataSet(vtkCompositeDataIterator *iter, vtkDataObject *dataObj) override
Sets the data set at the location pointed by the iterator.
vtkDataObjectTreeInternals * Internals
vtkDataObject * GetDataSet(vtkCompositeDataIterator *iter) override
Returns the dataset located at the position pointed by the iterator.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void Initialize() override
Restore data object to initial state,.
void DeepCopy(vtkDataObject *src) override
CompositeShallow, Shallow and Deep copy.
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
void SetChild(unsigned int index, vtkDataObject *)
Set child dataset at a given index.
void CompositeShallowCopy(vtkCompositeDataSet *src) override
CompositeShallow, Shallow and Deep copy.
void SetDataSetFrom(vtkDataObjectTreeIterator *iter, vtkDataObject *dataObj)
Sets the data at the location provided by a vtkDataObjectTreeIterator.
void SetNumberOfChildren(unsigned int num)
Set the number of children.
void CopyStructure(vtkCompositeDataSet *input) override
Copies the tree structure from the input.
vtkCompositeDataIterator * NewIterator() override
Return a new iterator (the iterator has to be deleted by user).
~vtkDataObjectTree() override
void RemoveChild(unsigned int index)
Remove the child at a given index.
virtual vtkTypeBool HasMetaData(vtkCompositeDataIterator *iter)
Returns if any meta-data associated with the position pointed by the iterator.
virtual vtkDataObjectTreeIterator * NewTreeIterator()
Return a new iterator (the iterator has to be deleted by user).
void ShallowCopy(vtkDataObject *src) override
CompositeShallow, Shallow and Deep copy.
general representation of visualization data
a simple class to control print indentation
Definition: vtkIndent.h:108
Key for string values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
vtkSmartPointer< vtkDataArray > GetData(const Ioss::GroupingEntity *entity, const std::string &fieldname, Ioss::Transform *transform=nullptr, Cache *cache=nullptr, const std::string &cachekey=std::string())
Returns a VTK array for a given field (fieldname) on the chosen block (or set) entity.
@ info
Definition: vtkX3D.h:376
@ index
Definition: vtkX3D.h:246
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_DEPRECATED_IN_9_3_0(reason)
#define VTK_DATA_OBJECT_TREE
Definition: vtkType.h:106
int vtkIdType
Definition: vtkType.h:315
#define VTK_NEWINSTANCE