VTK  9.3.0
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
24 #ifndef vtkDataObjectTree_h
25 #define vtkDataObjectTree_h
26 
27 #include "vtkCommonDataModelModule.h" // For export macro
28 #include "vtkCompositeDataSet.h"
29 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_3_0
30 
31 VTK_ABI_NAMESPACE_BEGIN
35 class vtkInformation;
37 class vtkDataObject;
38 
39 class VTKCOMMONDATAMODEL_EXPORT vtkDataObjectTree : public vtkCompositeDataSet
40 {
41 public:
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
49 
58 
64  void CopyStructure(vtkCompositeDataSet* input) override;
65 
72  void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) override;
73 
78 
79  // Needed because, otherwise vtkCompositeData::GetDataSet(unsigned int flatIndex) is hidden.
80  using Superclass::GetDataSet;
88 
98 
106 
111  unsigned long GetActualMemorySize() override;
112 
116  void Initialize() override;
117 
119 
123  void ShallowCopy(vtkDataObject* src) override;
124  void DeepCopy(vtkDataObject* src) override;
126 
130  VTK_DEPRECATED_IN_9_3_0("Please use ShallowCopy instead.")
131  void RecursiveShallowCopy(vtkDataObject* src) override;
132 
138  vtkIdType GetNumberOfPoints() override;
139 
145  vtkIdType GetNumberOfCells() override;
146 
148 
154 
158  int GetDataObjectType() override { return VTK_DATA_OBJECT_TREE; }
159 
160 protected:
162  ~vtkDataObjectTree() override;
163 
167  void SetNumberOfChildren(unsigned int num);
168 
172  unsigned int GetNumberOfChildren();
173 
178  void SetChild(unsigned int index, vtkDataObject*);
179 
183  void RemoveChild(unsigned int index);
184 
188  vtkDataObject* GetChild(unsigned int index);
189 
196 
201 
207 
215 
216  // The internal datastructure. Subclasses need not access this directly.
218 
220 
221 private:
222  vtkDataObjectTree(const vtkDataObjectTree&) = delete;
223  void operator=(const vtkDataObjectTree&) = delete;
224 };
225 
226 VTK_ABI_NAMESPACE_END
227 #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.
vtkTypeBool HasChildMetaData(unsigned int index)
Returns if meta-data information is available for the given child 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
vtkInformation * GetChildMetaData(unsigned int index)
Returns the meta-data at a given index.
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.
unsigned int GetNumberOfChildren()
Get the number of children.
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.
vtkDataObject * GetChild(unsigned int index)
Returns a child dataset at a given index.
general representation of visualization data
Definition: vtkDataObject.h:55
a simple class to control print indentation
Definition: vtkIndent.h:29
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