1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkGroupDataSetsFilter
* @brief groups inputs into a chosen composite dataset.
*
* vtkGroupDataSetsFilter is a filter that can combine multiple input datasets
* into a vtkMultBlockDataSet, vtkPartitionedDataSet, or a
* vtkPartitionedDataSetCollection.
*
* The inputs are added a individual blocks in the output and can be named
* assigned block-names using `SetInputName`.
*
* This is a more generic version of `vtkMultiBlockDataGroupFilter` and should
* be preferred.
*
* @sa vtkMergeBlocks vtkExtractBlock
*/
#ifndef vtkGroupDataSetsFilter_h
#define vtkGroupDataSetsFilter_h
#include "vtkDataObjectAlgorithm.h"
#include "vtkFiltersGeneralModule.h" // For export macro
#include <memory> // for std::unique_ptr
VTK_ABI_NAMESPACE_BEGIN
class VTKFILTERSGENERAL_EXPORT vtkGroupDataSetsFilter : public vtkDataObjectAlgorithm
{
public:
static vtkGroupDataSetsFilter* New();
vtkTypeMacro(vtkGroupDataSetsFilter, vtkDataObjectAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* Get/Set the output type. Supported values are
* `VTK_PARTITIONED_DATA_SET_COLLECTION`, `VTK_PARTITIONED_DATA_SET`, and
* `VTK_MULTIBLOCK_DATA_SET`.
*
* Default it VTK_PARTITIONED_DATA_SET_COLLECTION.
*/
vtkSetMacro(OutputType, int);
vtkGetMacro(OutputType, int);
void SetOutputTypeToPartitionedDataSet();
void SetOutputTypeToPartitionedDataSetCollection();
void SetOutputTypeToMultiBlockDataSet();
///@}
///@{
/**
* API to assign names for inputs. If not specified, the filter automatically
* creates sensible names based on the chosen output type.
*
* Names are not useful or relevant if output type is
* `VTK_PARTITIONED_DATA_SET` and hence are ignored for that type.
*/
void SetInputName(int index, const char* name);
const char* GetInputName(int index) const;
///@}
/**
* Clears all assigned input names.
*/
void ClearInputNames();
///@{
/**
* If on, for multiblock inputs if the output type is also multiblock, the first level will be
* combined.
* This is useful when this filter is called multiple times on the same multiblock to avoid
* creating many layers (legacy behavior related to distributed multiblock data).
*
* Default is off.
*/
vtkSetMacro(CombineFirstLayerMultiblock, bool);
vtkGetMacro(CombineFirstLayerMultiblock, bool);
vtkBooleanMacro(CombineFirstLayerMultiblock, bool);
///@}
protected:
vtkGroupDataSetsFilter();
~vtkGroupDataSetsFilter() override;
int FillInputPortInformation(int port, vtkInformation* info) override;
int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
int RequestDataObject(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
private:
vtkGroupDataSetsFilter(const vtkGroupDataSetsFilter&) = delete;
void operator=(const vtkGroupDataSetsFilter&) = delete;
int OutputType;
bool CombineFirstLayerMultiblock = false;
class vtkInternals;
std::unique_ptr<vtkInternals> Internals;
};
VTK_ABI_NAMESPACE_END
#endif
|
