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 =========================================================================*/
59 #ifndef vtkExecutive_h
60 #define vtkExecutive_h
61 
62 #include "vtkCommonExecutionModelModule.h" // For export macro
63 #include "vtkObject.h"
64 
65 class vtkAlgorithm;
66 class vtkAlgorithmOutput;
67 class vtkAlgorithmToExecutiveFriendship;
68 class vtkDataObject;
69 class vtkExecutiveInternals;
70 class vtkInformation;
77 
78 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkExecutive : public vtkObject
79 {
80 public:
81  vtkTypeMacro(vtkExecutive, vtkObject);
82  void PrintSelf(ostream& os, vtkIndent indent) override;
83 
88 
94  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
95 
108  virtual int ComputePipelineMTime(vtkInformation* request, vtkInformationVector** inInfoVec,
109  vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime);
110 
114  virtual int UpdateInformation() { return 1; }
115 
117 
121  virtual vtkTypeBool Update();
122  virtual vtkTypeBool Update(int port);
124 
126 
133 
138 
143 
148 
152  vtkInformation* GetInputInformation(int port, int connection);
153 
158 
163 
167  vtkExecutive* GetInputExecutive(int port, int connection);
168 
170 
175  virtual void SetOutputData(int port, vtkDataObject*);
177 
179 
182  virtual vtkDataObject* GetInputData(int port, int connection);
183  virtual vtkDataObject* GetInputData(int port, int connection, vtkInformationVector** inInfoVec);
185 
194 
205 
207 
210  bool UsesGarbageCollector() const override { return true; }
212 
218 
224 
230 
232 
242 
243  enum
244  {
246  RequestDownstream
247  };
248  enum
249  {
251  AfterForward
252  };
253 
258  virtual int CallAlgorithm(vtkInformation* request, int direction, vtkInformationVector** inInfo,
259  vtkInformationVector* outInfo);
260 
261 protected:
263  ~vtkExecutive() override;
264 
265  // Helper methods for subclasses.
266  int InputPortIndexInRange(int port, const char* action);
267  int OutputPortIndexInRange(int port, const char* action);
268 
269  // Called by methods to check for a recursive pipeline update. A
270  // request should be fulfilled without making another request. This
271  // is used to help enforce that behavior. Returns 1 if no recursive
272  // request is occurring, and 0 otherwise. An error message is
273  // produced automatically if 0 is returned. The first argument is
274  // the name of the calling method (the one that should not be
275  // invoked recursively during an update). The second argument is
276  // the recursive request information object, if any. It is used to
277  // construct the error message.
278  int CheckAlgorithm(const char* method, vtkInformation* request);
279 
280  virtual int ForwardDownstream(vtkInformation* request);
281  virtual int ForwardUpstream(vtkInformation* request);
282  virtual void CopyDefaultInformation(vtkInformation* request, int direction,
283  vtkInformationVector** inInfo, vtkInformationVector* outInfo);
284 
285  // Reset the pipeline update values in the given output information object.
287 
288  // Bring the existence of output data objects up to date.
289  virtual int UpdateDataObject() = 0;
290 
291  // Garbage collection support.
293 
294  virtual void SetAlgorithm(vtkAlgorithm* algorithm);
295 
296  // The algorithm managed by this executive.
298 
299  // Flag set when the algorithm is processing a request.
301 
302  // Pointers to an outside instance of input or output information.
303  // No references are held. These are used to implement internal
304  // pipelines.
307 
308 private:
309  // Store an information object for each output port of the algorithm.
310  vtkInformationVector* OutputInformation;
311 
312  // Internal implementation details.
313  vtkExecutiveInternals* ExecutiveInternal;
314 
315  friend class vtkAlgorithmToExecutiveFriendship;
316 
317 private:
318  vtkExecutive(const vtkExecutive&) = delete;
319  void operator=(const vtkExecutive&) = delete;
320 };
321 
322 #endif
Proxy object to connect input/output ports.
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:122
general representation of visualization data
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:79
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:305
vtkAlgorithm * Algorithm
Definition: vtkExecutive.h:297
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.
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:210
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:114
vtkInformationVector * SharedOutputInformation
Definition: vtkExecutive.h:306
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:119
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:82
@ info
Definition: vtkX3D.h:382
@ direction
Definition: vtkX3D.h:266
@ port
Definition: vtkX3D.h:453
int vtkTypeBool
Definition: vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287