VTK  9.3.0
vtkCompositeDataPipeline.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
38#ifndef vtkCompositeDataPipeline_h
39#define vtkCompositeDataPipeline_h
40
41#include "vtkCommonExecutionModelModule.h" // For export macro
43#include <vtkSmartPointer.h> // smart pointer
44
45#include <vector> // for vector in return type
46
47VTK_ABI_NAMESPACE_BEGIN
56
57class VTKCOMMONEXECUTIONMODEL_EXPORT vtkCompositeDataPipeline
59{
60public:
63 void PrintSelf(ostream& os, vtkIndent indent) override;
64
70
75 vtkDataObject* GetCompositeInputData(int port, int index, vtkInformationVector** inInfoVec);
76
82
91
103
112
113protected:
116
117 int ForwardUpstream(vtkInformation* request) override;
118 virtual int ForwardUpstream(int i, int j, vtkInformation* request);
119
120 // Copy information for the given request.
121 void CopyDefaultInformation(vtkInformation* request, int direction,
122 vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec) override;
123
126
128 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
129
131 vtkInformationVector* outInfoVec) override;
132
134 vtkInformationVector* outInfoVec) override;
135
136 // Override this check to account for update extent.
138 int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec) override;
139
140 // Check whether the data object in the pipeline information exists
141 // and has a valid type.
143 vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
144
145 // True when the pipeline is iterating over the current (simple) filter
146 // to produce composite output. In this case, ExecuteDataStart() should
147 // NOT Initialize() the composite output.
149
151 vtkInformationVector* outInfoVec, int compositePort);
152
154 vtkInformationVector* outInfoVec, int compositePort, int connection, vtkInformation* request,
155 std::vector<vtkSmartPointer<vtkCompositeDataSet>>& compositeOutput);
156
157 std::vector<vtkDataObject*> ExecuteSimpleAlgorithmForBlock(vtkInformationVector** inInfoVec,
158 vtkInformationVector* outInfoVec, vtkInformation* inInfo, vtkInformation* request,
159 vtkDataObject* dobj);
160
161 bool ShouldIterateOverInput(vtkInformationVector** inInfoVec, int& compositePort);
162
163 int InputTypeIsValid(int port, int index, vtkInformationVector** inInfoVec) override;
164
166
169
170 void ResetPipelineInformation(int port, vtkInformation*) override;
171
181 std::vector<vtkSmartPointer<vtkDataObject>> CreateOutputCompositeDataSet(
182 vtkCompositeDataSet* input, int compositePort, int numOutputPorts);
183
184 // Override this to handle UPDATE_COMPOSITE_INDICES().
186 vtkInformationVector* outInfoVec) override;
187
189
190 // Because we sometimes have to swap between "simple" data types and composite
191 // data types, we sometimes want to skip resetting the pipeline information.
193
203
204private:
206 void operator=(const vtkCompositeDataPipeline&) = delete;
207};
208
209VTK_ABI_NAMESPACE_END
210#endif
superclass for composite data iterators
Executive supporting composite datasets.
std::vector< vtkSmartPointer< vtkDataObject > > CreateOutputCompositeDataSet(vtkCompositeDataSet *input, int compositePort, int numOutputPorts)
Tries to create the best possible composite data output for the given input and non-composite algorit...
int ForwardUpstream(vtkInformation *request) override
vtkDataObject * GetCompositeOutputData(int port)
Returns the data object stored with the DATA_OBJECT() in the output port.
int NeedToExecuteBasedOnCompositeIndices(vtkInformation *outInfo)
static vtkInformationIntegerKey * LOAD_REQUESTED_BLOCKS()
An integer key that indicates to the source to load all requested blocks specified in UPDATE_COMPOSIT...
static vtkCompositeDataPipeline * New()
virtual void ExecuteSimpleAlgorithm(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int compositePort)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void CopyDefaultInformation(vtkInformation *request, int direction, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
void ResetPipelineInformation(int port, vtkInformation *) override
int ExecuteData(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
vtkDataObject * GetCompositeInputData(int port, int index, vtkInformationVector **inInfoVec)
Returns the data object stored with the DATA_OBJECT() in the input port.
void MarkOutputsGenerated(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
virtual int ForwardUpstream(int i, int j, vtkInformation *request)
virtual void PushInformation(vtkInformation *)
void ExecuteDataStart(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
int NeedToExecuteData(int outputPort, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
static vtkInformationIntegerVectorKey * UPDATE_COMPOSITE_INDICES()
UPDATE_COMPOSITE_INDICES is a key placed in the request to request a set of composite indices from a ...
int ExecuteDataObject(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
static vtkInformationObjectBaseKey * COMPOSITE_DATA_META_DATA()
COMPOSITE_DATA_META_DATA is a key placed in the output-port information by readers/sources producing ...
bool ShouldIterateOverInput(vtkInformationVector **inInfoVec, int &compositePort)
virtual void ExecuteEach(vtkCompositeDataIterator *iter, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int compositePort, int connection, vtkInformation *request, std::vector< vtkSmartPointer< vtkCompositeDataSet > > &compositeOutput)
virtual int CheckCompositeData(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
std::vector< vtkDataObject * > ExecuteSimpleAlgorithmForBlock(vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, vtkInformation *inInfo, vtkInformation *request, vtkDataObject *dobj)
int InputTypeIsValid(int port, int index, vtkInformationVector **inInfoVec) override
static vtkInformationIntegerVectorKey * DATA_COMPOSITE_INDICES()
COMPOSITE_INDICES() is put in the output information by the executive if the request has UPDATE_COMPO...
~vtkCompositeDataPipeline() override
static vtkInformationIntegerKey * SUPPRESS_RESET_PI()
static vtkInformationDoubleKey * BLOCK_AMOUNT_OF_DETAIL()
BLOCK_AMOUNT_OF_DETAIL is a key placed in the information about a multi-block dataset that indicates ...
virtual void PopInformation(vtkInformation *)
abstract superclass for composite (multi-block or AMR) datasets
general representation of visualization data
a simple class to control print indentation
Definition vtkIndent.h:29
Key for vtkDataObject values.
Key for double values in vtkInformation.
Key for integer values in vtkInformation.
Key for vtkObjectBase values.
Key for string values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Hold a reference to a vtkObjectBase instance.
Executive supporting partial updates.