VTK  9.1.20211230
vtkPartitionedDataSet.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPartitionedDataSet.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 vtkPartitionedDataSet_h
40 #define vtkPartitionedDataSet_h
41 
42 #include "vtkCommonDataModelModule.h" // For export macro
43 #include "vtkDataObjectTree.h"
44 
45 class vtkDataSet;
46 class VTKCOMMONDATAMODEL_EXPORT vtkPartitionedDataSet : public vtkDataObjectTree
47 {
48 public:
51  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
57  int GetDataObjectType() override { return VTK_PARTITIONED_DATA_SET; }
58 
64  void SetNumberOfPartitions(unsigned int numPartitions);
65 
69  unsigned int GetNumberOfPartitions();
70 
72 
75  vtkDataSet* GetPartition(unsigned int idx);
78 
83  void SetPartition(unsigned int idx, vtkDataObject* partition);
84 
88  int HasMetaData(unsigned int idx) { return this->Superclass::HasChildMetaData(idx); }
89 
95  vtkInformation* GetMetaData(unsigned int idx) { return this->Superclass::GetChildMetaData(idx); }
96 
98 
104 
109  {
110  return this->Superclass::GetMetaData(iter);
111  }
112 
117  {
118  return this->Superclass::HasMetaData(iter);
119  }
120 
126 
127 protected:
130 
136 
137 private:
139  void operator=(const vtkPartitionedDataSet&) = delete;
140 };
141 
142 #endif
superclass for composite data iterators
provides implementation for most abstract methods in the superclass vtkCompositeDataSet
general representation of visualization data
abstract class to specify dataset behavior
Definition: vtkDataSet.h:166
a simple class to control print indentation
Definition: vtkIndent.h:113
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
composite dataset to encapsulates a dataset consisting of partitions.
unsigned int GetNumberOfPartitions()
Returns the number of partitions.
static vtkPartitionedDataSet * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
~vtkPartitionedDataSet() override
int HasMetaData(unsigned int idx)
Returns true if meta-data is available for a given partition.
vtkDataSet * GetPartition(unsigned int idx)
Returns the partition at the given index.
vtkInformation * GetMetaData(unsigned int idx)
Returns the meta-data for the partition.
int GetDataObjectType() override
Return class name of data type (see vtkType.h for definitions).
vtkInformation * GetMetaData(vtkCompositeDataIterator *iter) override
Unhiding superclass method.
vtkDataObjectTree * CreateForCopyStructure(vtkDataObjectTree *) override
vtkPartitionedDataSet cannot contain non-leaf children.
static vtkPartitionedDataSet * New()
vtkDataObject * GetPartitionAsDataObject(unsigned int idx)
Returns the partition at the given index.
void RemoveNullPartitions()
Removes all partitions that have null datasets and resizes the dataset.
int HasMetaData(vtkCompositeDataIterator *iter) override
Unhiding superclass method.
void SetNumberOfPartitions(unsigned int numPartitions)
Set the number of partitionss.
void SetPartition(unsigned int idx, vtkDataObject *partition)
Sets the data object as the given partition.
static vtkPartitionedDataSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
@ info
Definition: vtkX3D.h:382
#define VTK_PARTITIONED_DATA_SET
Definition: vtkType.h:114