VTK  9.4.20241209
vtkPartitionedDataSet.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
30#ifndef vtkPartitionedDataSet_h
31#define vtkPartitionedDataSet_h
32
33#include "vtkCommonDataModelModule.h" // For export macro
34#include "vtkDataObjectTree.h"
35#include "vtkWrappingHints.h" // For VTK_MARSHALMANUAL
36
37VTK_ABI_NAMESPACE_BEGIN
38class vtkDataSet;
39class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALMANUAL vtkPartitionedDataSet : public vtkDataObjectTree
40{
41public:
44 void PrintSelf(ostream& os, vtkIndent indent) override;
45
51
57 void SetNumberOfPartitions(unsigned int numPartitions);
58
62 unsigned int GetNumberOfPartitions();
63
65
68 vtkDataSet* GetPartition(unsigned int idx);
71
76 void SetPartition(unsigned int idx, vtkDataObject* partition);
77
81 vtkTypeBool HasMetaData(unsigned int idx) { return this->Superclass::HasChildMetaData(idx); }
82
88 vtkInformation* GetMetaData(unsigned int idx) { return this->Superclass::GetChildMetaData(idx); }
89
91
97
102 {
103 return this->Superclass::GetMetaData(iter);
104 }
105
110 {
111 return this->Superclass::HasMetaData(iter);
112 }
113
119
120protected:
123
129
130private:
132 void operator=(const vtkPartitionedDataSet&) = delete;
133};
134
135VTK_ABI_NAMESPACE_END
136#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:108
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.
vtkDataObjectTree * CreateForCopyStructure(vtkDataObjectTree *) override
vtkPartitionedDataSet cannot contain non-leaf children.
vtkTypeBool HasMetaData(unsigned int idx)
Returns true if meta-data is available for a given partition.
vtkInformation * GetMetaData(vtkCompositeDataIterator *iter) override
Unhiding superclass method.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
~vtkPartitionedDataSet() override
int GetDataObjectType() override
Return class name of data type (see vtkType.h for definitions).
vtkTypeBool HasMetaData(vtkCompositeDataIterator *iter) override
Unhiding superclass method.
vtkInformation * GetMetaData(unsigned int idx)
Returns the meta-data for the partition.
static vtkPartitionedDataSet * New()
vtkDataObject * GetPartitionAsDataObject(unsigned int idx)
Returns the partition at the given index.
vtkDataSet * GetPartition(unsigned int idx)
Returns the partition at the given index.
static vtkPartitionedDataSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
void RemoveNullPartitions()
Removes all partitions that have null datasets and resizes the dataset.
static vtkPartitionedDataSet * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
void SetNumberOfPartitions(unsigned int numPartitions)
Set the number of partitions.
void SetPartition(unsigned int idx, vtkDataObject *partition)
Sets the data object as the given partition.
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_PARTITIONED_DATA_SET
Definition vtkType.h:102
#define VTK_MARSHALMANUAL