VTK
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 
36 class vtkAlgorithm;
37 class vtkAlgorithmOutput;
38 class vtkAlgorithmToExecutiveFriendship;
39 class vtkDataObject;
40 class vtkExecutiveInternals;
41 class vtkInformation;
48 
49 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkExecutive : public vtkObject
50 {
51 public:
52  vtkTypeMacro(vtkExecutive,vtkObject);
53  void PrintSelf(ostream& os, vtkIndent indent) override;
54 
58  vtkAlgorithm* GetAlgorithm();
59 
64  virtual vtkTypeBool ProcessRequest(vtkInformation* request,
65  vtkInformationVector** inInfo,
66  vtkInformationVector* outInfo);
67 
80  virtual int
81  ComputePipelineMTime(vtkInformation* request,
82  vtkInformationVector** inInfoVec,
83  vtkInformationVector* outInfoVec,
84  int requestFromOutputPort,
85  vtkMTimeType* mtime);
86 
90  virtual int UpdateInformation() {return 1;}
91 
93 
97  virtual vtkTypeBool Update();
98  virtual vtkTypeBool Update(int port);
100 
102 
106  int GetNumberOfInputPorts();
107  int GetNumberOfOutputPorts();
109 
113  int GetNumberOfInputConnections(int port);
114 
118  virtual vtkInformation* GetOutputInformation(int port);
119 
123  vtkInformationVector* GetOutputInformation();
124 
128  vtkInformation* GetInputInformation(int port, int connection);
129 
133  vtkInformationVector* GetInputInformation(int port);
134 
138  vtkInformationVector** GetInputInformation();
139 
143  vtkExecutive* GetInputExecutive(int port, int connection);
144 
146 
149  virtual vtkDataObject* GetOutputData(int port);
150  virtual void SetOutputData(int port, vtkDataObject*, vtkInformation *info);
151  virtual void SetOutputData(int port, vtkDataObject*);
153 
155 
158  virtual vtkDataObject* GetInputData(int port, int connection);
159  virtual vtkDataObject* GetInputData(int port, int connection,
160  vtkInformationVector **inInfoVec);
162 
179  void SetSharedInputInformation(vtkInformationVector** inInfoVec);
180  void SetSharedOutputInformation(vtkInformationVector* outInfoVec);
182 
184 
187  void Register(vtkObjectBase* o) override;
188  void UnRegister(vtkObjectBase* o) override;
190 
195  static vtkInformationExecutivePortKey* PRODUCER();
196 
201  static vtkInformationExecutivePortVectorKey* CONSUMERS();
202 
207  static vtkInformationIntegerKey* FROM_OUTPUT_PORT();
208 
210 
214  static vtkInformationIntegerKey* ALGORITHM_BEFORE_FORWARD();
215  static vtkInformationIntegerKey* ALGORITHM_AFTER_FORWARD();
216  static vtkInformationIntegerKey* ALGORITHM_DIRECTION();
217  static vtkInformationIntegerKey* FORWARD_DIRECTION();
218  static vtkInformationKeyVectorKey* KEYS_TO_COPY();
220 
221  enum { RequestUpstream, RequestDownstream };
222  enum { BeforeForward, AfterForward };
223 
228  virtual int CallAlgorithm(vtkInformation* request, int direction,
229  vtkInformationVector** inInfo,
230  vtkInformationVector* outInfo);
231 
232 protected:
233  vtkExecutive();
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,
255  vtkInformationVector* outInfo);
256 
257  // Reset the pipeline update values in the given output information object.
258  virtual void ResetPipelineInformation(int port, vtkInformation*)=0;
259 
260  // Bring the existence of output data objects up to date.
261  virtual int UpdateDataObject()=0;
262 
263  // Garbage collection support.
264  void ReportReferences(vtkGarbageCollector*) override;
265 
266  virtual void SetAlgorithm(vtkAlgorithm* algorithm);
267 
268  // The algorithm managed by this executive.
270 
271  // Flag set when the algorithm is processing a request.
273 
274  // Pointers to an outside instance of input or output information.
275  // No references are held. These are used to implement internal
276  // pipelines.
279 
280 private:
281  // Store an information object for each output port of the algorithm.
282  vtkInformationVector* OutputInformation;
283 
284  // Internal implementation details.
285  vtkExecutiveInternals* ExecutiveInternal;
286 
287  friend class vtkAlgorithmToExecutiveFriendship;
288 
289 private:
290  vtkExecutive(const vtkExecutive&) = delete;
291  void operator=(const vtkExecutive&) = delete;
292 };
293 
294 #endif
vtkExecutive::BeforeForward
Definition: vtkExecutive.h:222
vtkInformationKeyVectorKey
Key for vector-of-keys values.
Definition: vtkInformationKeyVectorKey.h:31
vtkExecutive::Algorithm
vtkAlgorithm * Algorithm
Definition: vtkExecutive.h:269
vtkObjectBase::Register
virtual void Register(vtkObjectBase *o)
Increase the reference count (mark as used by another object).
vtkAlgorithm
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:59
vtkX3D::direction
Definition: vtkX3D.h:260
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkObjectBase::ReportReferences
virtual void ReportReferences(vtkGarbageCollector *)
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:59
vtkExecutive::SharedOutputInformation
vtkInformationVector * SharedOutputInformation
Definition: vtkExecutive.h:278
vtkX3D::port
Definition: vtkX3D.h:447
vtkExecutive
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:49
vtkExecutive::UpdateInformation
virtual int UpdateInformation()
Bring the output information up to date.
Definition: vtkExecutive.h:90
vtkObjectBase
abstract base class for most VTK objects
Definition: vtkObjectBase.h:66
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:34
vtkInformationExecutivePortVectorKey
Key for vtkExecutive/Port value pair vectors.
Definition: vtkInformationExecutivePortVectorKey.h:34
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkInformationRequestKey
Key for pointer to pointer.
Definition: vtkInformationRequestKey.h:31
vtkObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkExecutive::RequestUpstream
Definition: vtkExecutive.h:221
vtkGarbageCollector
Detect and break reference loops.
Definition: vtkGarbageCollector.h:99
vtkObject.h
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:70
vtkX3D::info
Definition: vtkX3D.h:376
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:42
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkExecutive::InAlgorithm
int InAlgorithm
Definition: vtkExecutive.h:272
vtkObjectBase::UnRegister
virtual void UnRegister(vtkObjectBase *o)
Decrease the reference count (release by another object).
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:304
vtkInformationExecutivePortKey
Key for vtkExecutive/Port value pairs.
Definition: vtkInformationExecutivePortKey.h:34
vtkExecutive::SharedInputInformation
vtkInformationVector ** SharedInputInformation
Definition: vtkExecutive.h:277