VTK  9.2.6
vtkExecutive.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkExecutive.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=========================================================================*/
30#ifndef vtkExecutive_h
31#define vtkExecutive_h
32
33#include "vtkCommonExecutionModelModule.h" // For export macro
34#include "vtkObject.h"
35
36class vtkAlgorithm;
38class vtkAlgorithmToExecutiveFriendship;
39class vtkDataObject;
40class vtkExecutiveInternals;
41class vtkInformation;
48
49class VTKCOMMONEXECUTIONMODEL_EXPORT vtkExecutive : public vtkObject
50{
51public:
52 vtkTypeMacro(vtkExecutive, vtkObject);
53 void PrintSelf(ostream& os, vtkIndent indent) override;
54
59
65 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
66
79 virtual int ComputePipelineMTime(vtkInformation* request, vtkInformationVector** inInfoVec,
80 vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime);
81
85 virtual int UpdateInformation() { return 1; }
86
88
93 virtual vtkTypeBool Update(int port);
95
97
104
109
114
119
123 vtkInformation* GetInputInformation(int port, int connection);
124
129
134
138 vtkExecutive* GetInputExecutive(int port, int connection);
139
141
144 virtual vtkDataObject* GetOutputData(int port);
145 virtual void SetOutputData(int port, vtkDataObject*, vtkInformation* info);
146 virtual void SetOutputData(int port, vtkDataObject*);
148
150
153 virtual vtkDataObject* GetInputData(int port, int connection);
154 virtual vtkDataObject* GetInputData(int port, int connection, vtkInformationVector** inInfoVec);
156
165
176
178
181 bool UsesGarbageCollector() const override { return true; }
183
189
195
201
203
213
214 enum
215 {
217 RequestDownstream
218 };
219 enum
220 {
222 AfterForward
223 };
224
229 virtual int CallAlgorithm(vtkInformation* request, int direction, vtkInformationVector** inInfo,
230 vtkInformationVector* outInfo);
231
232protected:
234 ~vtkExecutive() override;
235
236 // Helper methods for subclasses.
237 int InputPortIndexInRange(int port, const char* action);
238 int OutputPortIndexInRange(int port, const char* action);
239
240 // Called by methods to check for a recursive pipeline update. A
241 // request should be fulfilled without making another request. This
242 // is used to help enforce that behavior. Returns 1 if no recursive
243 // request is occurring, and 0 otherwise. An error message is
244 // produced automatically if 0 is returned. The first argument is
245 // the name of the calling method (the one that should not be
246 // invoked recursively during an update). The second argument is
247 // the recursive request information object, if any. It is used to
248 // construct the error message.
249 int CheckAlgorithm(const char* method, vtkInformation* request);
250
251 virtual int ForwardDownstream(vtkInformation* request);
252 virtual int ForwardUpstream(vtkInformation* request);
253 virtual void CopyDefaultInformation(vtkInformation* request, int direction,
254 vtkInformationVector** inInfo, vtkInformationVector* outInfo);
255
256 // Reset the pipeline update values in the given output information object.
257 virtual void ResetPipelineInformation(int port, vtkInformation*) = 0;
258
259 // Bring the existence of output data objects up to date.
260 virtual int UpdateDataObject() = 0;
261
262 // Garbage collection support.
264
265 virtual void SetAlgorithm(vtkAlgorithm* algorithm);
266
267 // The algorithm managed by this executive.
269
270 // Flag set when the algorithm is processing a request.
272
273 // Pointers to an outside instance of input or output information.
274 // No references are held. These are used to implement internal
275 // pipelines.
278
279private:
280 // Store an information object for each output port of the algorithm.
281 vtkInformationVector* OutputInformation;
282
283 // Internal implementation details.
284 vtkExecutiveInternals* ExecutiveInternal;
285
286 friend class vtkAlgorithmToExecutiveFriendship;
287
288private:
289 vtkExecutive(const vtkExecutive&) = delete;
290 void operator=(const vtkExecutive&) = delete;
291};
292
293#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.
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:40
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:63
int vtkTypeBool
Definition vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287