VTK
vtkCompositeDataSet.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCompositeDataSet.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 =========================================================================*/
39 #ifndef vtkCompositeDataSet_h
40 #define vtkCompositeDataSet_h
41 
42 #include "vtkCommonDataModelModule.h" // For export macro
43 #include "vtkDataObject.h"
44 
46 class vtkCompositeDataSetInternals;
47 class vtkInformation;
50 
51 class VTKCOMMONDATAMODEL_EXPORT vtkCompositeDataSet : public vtkDataObject
52 {
53 public:
55  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
61 
66  int GetDataObjectType() override {return VTK_COMPOSITE_DATA_SET;}
67 
73  virtual void CopyStructure(vtkCompositeDataSet* input)=0;
74 
81  virtual void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj)=0;
82 
90 
91 
96  unsigned long GetActualMemorySize() override;
97 
99 
105 
109  void Initialize() override;
110 
112 
115  void ShallowCopy(vtkDataObject *src) override;
116  void DeepCopy(vtkDataObject *src) override;
118 
125 
132 
137 
146 
147  protected:
150  private:
151 
152  vtkCompositeDataSet(const vtkCompositeDataSet&) = delete;
153  void operator=(const vtkCompositeDataSet&) = delete;
154 
155 };
156 
157 #endif
vtkInformationStringKey
Key for string values in vtkInformation.
Definition: vtkInformationStringKey.h:37
vtkCompositeDataSet::NewIterator
virtual vtkCompositeDataIterator * NewIterator()=0
Return a new iterator (the iterator has to be deleted by user).
vtkCompositeDataSet::vtkCompositeDataSet
vtkCompositeDataSet()
vtkCompositeDataSet::ShallowCopy
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
vtkCompositeDataSet::SetDataSet
virtual void SetDataSet(vtkCompositeDataIterator *iter, vtkDataObject *dataObj)=0
Sets the data set at the location pointed by the iterator.
VTK_COMPOSITE_DATA_SET
#define VTK_COMPOSITE_DATA_SET
Definition: vtkType.h:102
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkCompositeDataSet::DeepCopy
void DeepCopy(vtkDataObject *src) override
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkCompositeDataSet::GetDataObjectType
int GetDataObjectType() override
Return class name of data type (see vtkType.h for definitions).
Definition: vtkCompositeDataSet.h:66
vtkCompositeDataSet::GetData
static vtkCompositeDataSet * GetData(vtkInformationVector *v, int i=0)
vtkCompositeDataSet::Initialize
void Initialize() override
Restore data object to initial state,.
vtkCompositeDataSet
abstract superclass for composite (multi-block or AMR) datasets
Definition: vtkCompositeDataSet.h:52
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:35
vtkCompositeDataIterator
superclass for composite data iterators
Definition: vtkCompositeDataIterator.h:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkCompositeDataSet::GetActualMemorySize
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
vtkCompositeDataSet::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCompositeDataSet::GetNumberOfCells
virtual vtkIdType GetNumberOfCells()
Returns the total number of cells of all blocks.
vtkCompositeDataSet::~vtkCompositeDataSet
~vtkCompositeDataSet() override
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkDataObject.h
vtkCompositeDataSet::GetNumberOfPoints
virtual vtkIdType GetNumberOfPoints()
Returns the total number of points of all blocks.
vtkCompositeDataSet::CURRENT_PROCESS_CAN_LOAD_BLOCK
static vtkInformationIntegerKey * CURRENT_PROCESS_CAN_LOAD_BLOCK()
Key used to indicate that the current process can load the data in the node.
vtkCompositeDataSet::GetDataSet
virtual vtkDataObject * GetDataSet(vtkCompositeDataIterator *iter)=0
Returns the dataset located at the positiong pointed by the iterator.
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition: vtkWrappingHints.h:39
vtkCompositeDataSet::NAME
static vtkInformationStringKey * NAME()
Key used to put node name in the meta-data associated with a node.
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:65
vtkCompositeDataSet::GetData
static vtkCompositeDataSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
vtkCompositeDataSet::CopyStructure
virtual void CopyStructure(vtkCompositeDataSet *input)=0
Copies the tree structure from the input.