VTK  9.3.0
vtkExecutive.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
18#ifndef vtkExecutive_h
19#define vtkExecutive_h
20
21#include "vtkCommonExecutionModelModule.h" // For export macro
22#include "vtkObject.h"
23
24VTK_ABI_NAMESPACE_BEGIN
25class vtkAlgorithm;
27class vtkAlgorithmToExecutiveFriendship;
28class vtkDataObject;
29class vtkExecutiveInternals;
30class vtkInformation;
37
38class VTKCOMMONEXECUTIONMODEL_EXPORT vtkExecutive : public vtkObject
39{
40public:
41 vtkTypeMacro(vtkExecutive, vtkObject);
42 void PrintSelf(ostream& os, vtkIndent indent) override;
43
48
54 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
55
68 virtual int ComputePipelineMTime(vtkInformation* request, vtkInformationVector** inInfoVec,
69 vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime);
70
74 virtual int UpdateInformation() { return 1; }
75
77
82 virtual vtkTypeBool Update(int port);
84
86
93
98
103
108
112 vtkInformation* GetInputInformation(int port, int connection);
113
118
123
127 vtkExecutive* GetInputExecutive(int port, int connection);
128
130
133 virtual vtkDataObject* GetOutputData(int port);
134 virtual void SetOutputData(int port, vtkDataObject*, vtkInformation* info);
135 virtual void SetOutputData(int port, vtkDataObject*);
137
139
142 virtual vtkDataObject* GetInputData(int port, int connection);
143 virtual vtkDataObject* GetInputData(int port, int connection, vtkInformationVector** inInfoVec);
145
154
165
167
170 bool UsesGarbageCollector() const override { return true; }
172
178
184
190
192
202
203 enum
204 {
206 RequestDownstream
207 };
208 enum
209 {
211 AfterForward
212 };
213
218 virtual int CallAlgorithm(vtkInformation* request, int direction, vtkInformationVector** inInfo,
219 vtkInformationVector* outInfo);
220
221protected:
223 ~vtkExecutive() override;
224
225 // Helper methods for subclasses.
226 int InputPortIndexInRange(int port, const char* action);
227 int OutputPortIndexInRange(int port, const char* action);
228
229 // Called by methods to check for a recursive pipeline update. A
230 // request should be fulfilled without making another request. This
231 // is used to help enforce that behavior. Returns 1 if no recursive
232 // request is occurring, and 0 otherwise. An error message is
233 // produced automatically if 0 is returned. The first argument is
234 // the name of the calling method (the one that should not be
235 // invoked recursively during an update). The second argument is
236 // the recursive request information object, if any. It is used to
237 // construct the error message.
238 int CheckAlgorithm(const char* method, vtkInformation* request);
239
245
246 virtual int ForwardDownstream(vtkInformation* request);
247 virtual int ForwardUpstream(vtkInformation* request);
248 virtual void CopyDefaultInformation(vtkInformation* request, int direction,
249 vtkInformationVector** inInfo, vtkInformationVector* outInfo);
250
251 // Reset the pipeline update values in the given output information object.
252 virtual void ResetPipelineInformation(int port, vtkInformation*) = 0;
253
254 // Bring the existence of output data objects up to date.
255 virtual int UpdateDataObject() = 0;
256
257 // Garbage collection support.
259
260 virtual void SetAlgorithm(vtkAlgorithm* algorithm);
261
262 // The algorithm managed by this executive.
264
265 // Flag set when the algorithm is processing a request.
267
268 // Pointers to an outside instance of input or output information.
269 // No references are held. These are used to implement internal
270 // pipelines.
273
274private:
275 // Store an information object for each output port of the algorithm.
276 vtkInformationVector* OutputInformation;
277
278 // Internal implementation details.
279 vtkExecutiveInternals* ExecutiveInternal;
280
281 friend class vtkAlgorithmToExecutiveFriendship;
282
283 vtkExecutive(const vtkExecutive&) = delete;
284 void operator=(const vtkExecutive&) = delete;
285};
286
287VTK_ABI_NAMESPACE_END
288#endif
Proxy object to connect input/output ports.
Superclass for all sources, filters, and sinks in VTK.
general representation of visualization data
Superclass for all pipeline executives in VTK.
int CheckAlgorithm(const char *method, vtkInformation *request)
virtual int ForwardDownstream(vtkInformation *request)
virtual vtkTypeBool Update()
Bring the algorithm's outputs up-to-date.
virtual vtkTypeBool Update(int port)
Bring the algorithm's outputs up-to-date.
virtual int ForwardUpstream(vtkInformation *request)
vtkInformationVector * GetOutputInformation()
Get the pipeline information object for all output ports.
void ReportReferences(vtkGarbageCollector *) override
static vtkInformationKeyVectorKey * KEYS_TO_COPY()
Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
~vtkExecutive() override
virtual int UpdateDataObject()=0
vtkInformationVector ** SharedInputInformation
vtkExecutive * GetInputExecutive(int port, int connection)
Get the executive managing the given input connection.
vtkAlgorithm * Algorithm
virtual vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
Generalized interface for asking the executive to fulfill pipeline requests.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkInformationIntegerKey * ALGORITHM_BEFORE_FORWARD()
Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
virtual vtkDataObject * GetInputData(int port, int connection, vtkInformationVector **inInfoVec)
Get the data object for an input port of the algorithm.
bool CheckAbortedInput(vtkInformationVector **inInfoVec)
Checks to see if an inputs have ABORTED set.
static vtkInformationIntegerKey * FROM_OUTPUT_PORT()
Information key to store the output port number from which a request is made.
void SetSharedOutputInformation(vtkInformationVector *outInfoVec)
Get the output port that produces the given data object.
virtual void SetAlgorithm(vtkAlgorithm *algorithm)
bool UsesGarbageCollector() const override
Participate in garbage collection.
vtkInformation * GetInputInformation(int port, int connection)
Get the pipeline information for the given input connection.
static vtkInformationIntegerKey * ALGORITHM_AFTER_FORWARD()
Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
virtual int ComputePipelineMTime(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
A special version of ProcessRequest meant specifically for the pipeline modified time request.
static vtkInformationIntegerKey * FORWARD_DIRECTION()
Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
virtual void ResetPipelineInformation(int port, vtkInformation *)=0
vtkInformationVector * GetInputInformation(int port)
Get the pipeline information vectors for the given input port.
virtual vtkInformation * GetOutputInformation(int port)
Get the pipeline information object for the given output port.
virtual vtkDataObject * GetInputData(int port, int connection)
Get the data object for an input port of the algorithm.
virtual void SetOutputData(int port, vtkDataObject *, vtkInformation *info)
Get/Set the data object for an output port of the algorithm.
int GetNumberOfInputPorts()
Get the number of input/output ports for the algorithm associated with this executive.
static vtkInformationExecutivePortKey * PRODUCER()
Information key to store the executive/port number producing an information object.
virtual vtkDataObject * GetOutputData(int port)
Get/Set the data object for an output port of the algorithm.
vtkAlgorithm * GetAlgorithm()
Get the algorithm to which this executive has been assigned.
void SetSharedInputInformation(vtkInformationVector **inInfoVec)
Get the output port that produces the given data object.
int OutputPortIndexInRange(int port, const char *action)
virtual void SetOutputData(int port, vtkDataObject *)
Get/Set the data object for an output port of the algorithm.
static vtkInformationExecutivePortVectorKey * CONSUMERS()
Information key to store the executive/port number pairs consuming an information object.
virtual int UpdateInformation()
Bring the output information up to date.
vtkInformationVector * SharedOutputInformation
virtual int CallAlgorithm(vtkInformation *request, int direction, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
An API to CallAlgorithm that allows you to pass in the info objects to be used.
vtkInformationVector ** GetInputInformation()
Get the pipeline information vectors for all inputs.
virtual void CopyDefaultInformation(vtkInformation *request, int direction, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
int GetNumberOfOutputPorts()
Get the number of input/output ports for the algorithm associated with this executive.
int InputPortIndexInRange(int port, const char *action)
static vtkInformationIntegerKey * ALGORITHM_DIRECTION()
Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
int GetNumberOfInputConnections(int port)
Get the number of input connections on the given port.
Detect and break reference loops.
a simple class to control print indentation
Definition vtkIndent.h:29
Key for vtkExecutive/Port value pairs.
Key for vtkExecutive/Port value pair vectors.
Key for integer values in vtkInformation.
Key for vector-of-keys values.
Key for pointer to pointer.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition vtkObject.h:49
int vtkTypeBool
Definition vtkABI.h:64
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270