VTK
vtkDataObjectTree.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDataObjectTree.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 =========================================================================*/
33 #ifndef vtkDataObjectTree_h
34 #define vtkDataObjectTree_h
35 
36 #include "vtkCommonDataModelModule.h" // For export macro
37 #include "vtkCompositeDataSet.h"
38 
42 class vtkInformation;
44 class vtkDataObject;
45 
46 class VTKCOMMONDATAMODEL_EXPORT vtkDataObjectTree : public vtkCompositeDataSet
47 {
48 public:
50  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
56 
65 
71  void CopyStructure(vtkCompositeDataSet* input) override;
72 
80  vtkDataObject* dataObj) override;
81 
86 
94 
104 
112 
117  unsigned long GetActualMemorySize() override;
118 
122  void Initialize() override;
123 
125 
128  void ShallowCopy(vtkDataObject *src) override;
129  void DeepCopy(vtkDataObject *src) override;
131 
138 
145 
147 
153 
154 protected:
156  ~vtkDataObjectTree() override;
157 
161  void SetNumberOfChildren(unsigned int num);
162 
166  unsigned int GetNumberOfChildren();
167 
172  void SetChild(unsigned int index, vtkDataObject*);
173 
177  void RemoveChild(unsigned int index);
178 
182  vtkDataObject* GetChild(unsigned int num);
183 
190 
195 
200  int HasChildMetaData(unsigned int index);
201 
202  // The internal datastructure. Subclasses need not access this directly.
204 
206 
207 private:
208  vtkDataObjectTree(const vtkDataObjectTree&) = delete;
209  void operator=(const vtkDataObjectTree&) = delete;
210 
211 };
212 
213 #endif
vtkDataObjectTreeIterator::vtkDataObjectTree
friend class vtkDataObjectTree
Definition: vtkDataObjectTreeIterator.h:135
vtkInformationStringKey
Key for string values in vtkInformation.
Definition: vtkInformationStringKey.h:37
vtkDataObjectTree::SetNumberOfChildren
void SetNumberOfChildren(unsigned int num)
Set the number of children.
vtkDataObjectTree
provides implementation for most abstract methods in the superclass vtkCompositeDataSet
Definition: vtkDataObjectTree.h:47
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkDataObjectTree::GetNumberOfCells
vtkIdType GetNumberOfCells() override
Returns the total number of cells of all blocks.
vtkDataObjectTree::SetChildMetaData
void SetChildMetaData(unsigned int index, vtkInformation *info)
Sets the meta-data at a given index.
vtkDataObjectTree::Internals
vtkDataObjectTreeInternals * Internals
Definition: vtkDataObjectTree.h:203
vtkDataObjectTree::SetDataSet
void SetDataSet(vtkCompositeDataIterator *iter, vtkDataObject *dataObj) override
Sets the data set at the location pointed by the iterator.
vtkDataObjectTree::CopyStructure
void CopyStructure(vtkCompositeDataSet *input) override
Copies the tree structure from the input.
vtkDataObjectTree::GetDataSet
vtkDataObject * GetDataSet(vtkCompositeDataIterator *iter) override
Returns the dataset located at the positiong pointed by the iterator.
vtkDataObjectTree::SetChild
void SetChild(unsigned int index, vtkDataObject *)
Set child dataset at a given index.
vtkDataObjectTree::NewIterator
vtkCompositeDataIterator * NewIterator() override
Return a new iterator (the iterator has to be deleted by user).
vtkDataObjectTree::SetDataSetFrom
void SetDataSetFrom(vtkDataObjectTreeIterator *iter, vtkDataObject *dataObj)
Sets the data at the location provided by a vtkDataObjectTreeIterator.
vtkCompositeDataSet
abstract superclass for composite (multi-block or AMR) datasets
Definition: vtkCompositeDataSet.h:52
vtkDataObjectTree::ShallowCopy
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
vtkDataObjectTree::RemoveChild
void RemoveChild(unsigned int index)
Remove the child at a given index.
vtkCompositeDataIterator
superclass for composite data iterators
Definition: vtkCompositeDataIterator.h:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkDataObjectTree::vtkDataObjectTree
vtkDataObjectTree()
vtkDataObjectTree::GetMetaData
virtual vtkInformation * GetMetaData(vtkCompositeDataIterator *iter)
Returns the meta-data associated with the position pointed by the iterator.
vtkCompositeDataSet.h
vtkDataObjectTree::GetData
static vtkDataObjectTree * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
vtkDataObjectTree::GetChild
vtkDataObject * GetChild(unsigned int num)
Returns a child dataset at a given index.
vtkDataObjectTree::DeepCopy
void DeepCopy(vtkDataObject *src) override
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkDataObjectTree::GetActualMemorySize
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
vtkDataObjectTree::~vtkDataObjectTree
~vtkDataObjectTree() override
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkDataObjectTree::GetNumberOfChildren
unsigned int GetNumberOfChildren()
Get the number of children.
vtkDataObjectTree::GetNumberOfPoints
vtkIdType GetNumberOfPoints() override
Returns the total number of points of all blocks.
vtkDataObjectTree::NewTreeIterator
virtual vtkDataObjectTreeIterator * NewTreeIterator()
Return a new iterator (the iterator has to be deleted by user).
vtkDataObjectTree::GetChildMetaData
vtkInformation * GetChildMetaData(unsigned int index)
Returns the meta-data at a given index.
vtkDataObjectTreeIterator
superclass for composite data iterators
Definition: vtkDataObjectTreeIterator.h:40
vtkDataObjectTree::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition: vtkWrappingHints.h:39
vtkDataObjectTree::GetData
static vtkDataObjectTree * GetData(vtkInformationVector *v, int i=0)
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:65
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkDataObjectTree::HasChildMetaData
int HasChildMetaData(unsigned int index)
Returns if meta-data information is available for the given child index.
vtkDataObjectTree::HasMetaData
virtual int HasMetaData(vtkCompositeDataIterator *iter)
Returns if any meta-data associated with the position pointed by the iterator.
vtkDataObjectTree::Initialize
void Initialize() override
Restore data object to initial state,.
vtkDataObjectTreeInternals
Definition: vtkDataObjectTreeInternals.h:45