VTK  9.3.20240328
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
47 #ifndef vtkExecutive_h
48 #define vtkExecutive_h
49 
50 #include "vtkCommonExecutionModelModule.h" // For export macro
51 #include "vtkObject.h"
52 
53 VTK_ABI_NAMESPACE_BEGIN
54 class vtkAlgorithm;
55 class vtkAlgorithmOutput;
56 class vtkAlgorithmToExecutiveFriendship;
57 class vtkDataObject;
58 class vtkExecutiveInternals;
59 class vtkInformation;
66 
67 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkExecutive : public vtkObject
68 {
69 public:
70  vtkTypeMacro(vtkExecutive, vtkObject);
71  void PrintSelf(ostream& os, vtkIndent indent) override;
72 
77 
83  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
84 
97  virtual int ComputePipelineMTime(vtkInformation* request, vtkInformationVector** inInfoVec,
98  vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime);
99 
103  virtual int UpdateInformation() { return 1; }
104 
106 
110  virtual vtkTypeBool Update();
111  virtual vtkTypeBool Update(int port);
113 
115 
122 
127 
132 
137 
141  vtkInformation* GetInputInformation(int port, int connection);
142 
147 
152 
156  vtkExecutive* GetInputExecutive(int port, int connection);
157 
159 
164  virtual void SetOutputData(int port, vtkDataObject*);
166 
168 
171  virtual vtkDataObject* GetInputData(int port, int connection);
172  virtual vtkDataObject* GetInputData(int port, int connection, vtkInformationVector** inInfoVec);
174 
183 
194 
196 
199  bool UsesGarbageCollector() const override { return true; }
201 
207 
213 
219 
221 
231 
232  enum
233  {
235  RequestDownstream
236  };
237  enum
238  {
240  AfterForward
241  };
242 
247  virtual int CallAlgorithm(vtkInformation* request, int direction, vtkInformationVector** inInfo,
248  vtkInformationVector* outInfo);
249 
250 protected:
252  ~vtkExecutive() override;
253 
254  // Helper methods for subclasses.
255  int InputPortIndexInRange(int port, const char* action);
256  int OutputPortIndexInRange(int port, const char* action);
257 
258  // Called by methods to check for a recursive pipeline update. A
259  // request should be fulfilled without making another request. This
260  // is used to help enforce that behavior. Returns 1 if no recursive
261  // request is occurring, and 0 otherwise. An error message is
262  // produced automatically if 0 is returned. The first argument is
263  // the name of the calling method (the one that should not be
264  // invoked recursively during an update). The second argument is
265  // the recursive request information object, if any. It is used to
266  // construct the error message.
267  int CheckAlgorithm(const char* method, vtkInformation* request);
268 
274 
275  virtual int ForwardDownstream(vtkInformation* request);
276  virtual int ForwardUpstream(vtkInformation* request);
277  virtual void CopyDefaultInformation(vtkInformation* request, int direction,
278  vtkInformationVector** inInfo, vtkInformationVector* outInfo);
279 
280  // Reset the pipeline update values in the given output information object.
282 
283  // Bring the existence of output data objects up to date.
284  virtual int UpdateDataObject() = 0;
285 
286  // Garbage collection support.
288 
289  virtual void SetAlgorithm(vtkAlgorithm* algorithm);
290 
291  // The algorithm managed by this executive.
293 
294  // Flag set when the algorithm is processing a request.
296 
297  // Pointers to an outside instance of input or output information.
298  // No references are held. These are used to implement internal
299  // pipelines.
302 
303 private:
304  // Store an information object for each output port of the algorithm.
305  vtkInformationVector* OutputInformation;
306 
307  // Internal implementation details.
308  vtkExecutiveInternals* ExecutiveInternal;
309 
310  friend class vtkAlgorithmToExecutiveFriendship;
311 
312  vtkExecutive(const vtkExecutive&) = delete;
313  void operator=(const vtkExecutive&) = delete;
314 };
315 
316 VTK_ABI_NAMESPACE_END
317 #endif
Proxy object to connect input/output ports.
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:161
general representation of visualization data
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:68
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.
vtkExecutive * GetInputExecutive(int port, int connection)
Get the executive managing the given input connection.
vtkInformationVector ** GetInputInformation()
Get the pipeline information vectors for all inputs.
static vtkInformationIntegerKey * ALGORITHM_BEFORE_FORWARD()
Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
virtual int ForwardUpstream(vtkInformation *request)
static vtkInformationKeyVectorKey * KEYS_TO_COPY()
Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
void ReportReferences(vtkGarbageCollector *) override
virtual vtkDataObject * GetInputData(int port, int connection)
Get the data object for an input port of the algorithm.
~vtkExecutive() override
virtual int UpdateDataObject()=0
vtkInformationVector ** SharedInputInformation
Definition: vtkExecutive.h:300
vtkAlgorithm * Algorithm
Definition: vtkExecutive.h:292
static vtkInformationIntegerKey * FROM_OUTPUT_PORT()
Information key to store the output port number from which a request is made.
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.
bool CheckAbortedInput(vtkInformationVector **inInfoVec)
Checks to see if an inputs have ABORTED set.
vtkAlgorithm * GetAlgorithm()
Get the algorithm to which this executive has been assigned.
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.
Definition: vtkExecutive.h:199
static vtkInformationIntegerKey * ALGORITHM_AFTER_FORWARD()
Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
static vtkInformationIntegerKey * ALGORITHM_DIRECTION()
Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
vtkInformationVector * GetInputInformation(int port)
Get the pipeline information vectors for the given input port.
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.
virtual void ResetPipelineInformation(int port, vtkInformation *)=0
vtkInformation * GetInputInformation(int port, int connection)
Get the pipeline information for the given input connection.
vtkInformationVector * GetOutputInformation()
Get the pipeline information object for all output ports.
virtual vtkInformation * GetOutputInformation(int port)
Get the pipeline information object for the given output port.
virtual void SetOutputData(int port, vtkDataObject *, vtkInformation *info)
Get/Set the data object for an output port of the algorithm.
static vtkInformationExecutivePortKey * PRODUCER()
Information key to store the executive/port number producing an information object.
int GetNumberOfInputPorts()
Get the number of input/output ports for the algorithm associated with this executive.
static vtkInformationIntegerKey * FORWARD_DIRECTION()
Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
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.
virtual int UpdateInformation()
Bring the output information up to date.
Definition: vtkExecutive.h:103
vtkInformationVector * SharedOutputInformation
Definition: vtkExecutive.h:301
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.
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)
virtual vtkDataObject * GetOutputData(int port)
Get/Set the data object for an output port of the algorithm.
virtual vtkDataObject * GetInputData(int port, int connection, vtkInformationVector **inInfoVec)
Get the data object for an input port of the algorithm.
static vtkInformationExecutivePortVectorKey * CONSUMERS()
Information key to store the executive/port number pairs consuming an information object.
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:108
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:161
@ info
Definition: vtkX3D.h:376
@ direction
Definition: vtkX3D.h:260
@ port
Definition: vtkX3D.h:447
int vtkTypeBool
Definition: vtkABI.h:64
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270