/usr/include/vtk-5.8/vtkExecutive.h is in libvtk5-dev 5.8.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | /*=========================================================================
Program: Visualization Toolkit
Module: vtkExecutive.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkExecutive - Superclass for all pipeline executives in VTK.
// .SECTION Description
// vtkExecutive is the superclass for all pipeline executives in VTK.
// A VTK executive is responsible for controlling one instance of
// vtkAlgorithm. A pipeline consists of one or more executives that
// control data flow. Every reader, source, writer, or data
// processing algorithm in the pipeline is implemented in an instance
// of vtkAlgorithm.
#ifndef __vtkExecutive_h
#define __vtkExecutive_h
#include "vtkObject.h"
class vtkAlgorithm;
class vtkAlgorithmOutput;
class vtkAlgorithmToExecutiveFriendship;
class vtkDataObject;
class vtkExecutiveInternals;
class vtkInformation;
class vtkInformationExecutivePortKey;
class vtkInformationExecutivePortVectorKey;
class vtkInformationIntegerKey;
class vtkInformationRequestKey;
class vtkInformationKeyVectorKey;
class vtkInformationVector;
class VTK_FILTERING_EXPORT vtkExecutive : public vtkObject
{
public:
vtkTypeMacro(vtkExecutive,vtkObject);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Get the algorithm to which this executive has been assigned.
vtkAlgorithm* GetAlgorithm();
// Description:
// Generalized interface for asking the executive to fullfill
// pipeline requests.
virtual int ProcessRequest(vtkInformation* request,
vtkInformationVector** inInfo,
vtkInformationVector* outInfo);
// Description:
// A special version of ProcessRequest meant specifically for the
// pipeline modified time request. This is an optimization since
// the request is called so often and it travels the full length of
// the pipeline. We augment the signature with method arguments
// containing the common information, specifically the output port
// through which the request was made and the resulting modified
// time. Note that unlike ProcessRequest the request information
// object may be NULL for this method. It also does not contain a
// request identifcation key because the request is known from the
// method name.
virtual int
ComputePipelineMTime(vtkInformation* request,
vtkInformationVector** inInfoVec,
vtkInformationVector* outInfoVec,
int requestFromOutputPort,
unsigned long* mtime);
// Description:
// Bring the algorithm's outputs up-to-date. Returns 1 for success
// and 0 for failure.
virtual int Update();
virtual int Update(int port);
// Description:
// Get the number of input/output ports for the algorithm associated
// with this executive. Returns 0 if no algorithm is set.
int GetNumberOfInputPorts();
int GetNumberOfOutputPorts();
// Description:
// Get the number of input connections on the given port.
int GetNumberOfInputConnections(int port);
// Description:
// Get the pipeline information object for the given output port.
virtual vtkInformation* GetOutputInformation(int port);
// Description:
// Get the pipeline information object for all output ports.
vtkInformationVector* GetOutputInformation();
// Description:
// Get the pipeline information for the given input connection.
vtkInformation* GetInputInformation(int port, int connection);
// Description:
// Get the pipeline information vectors for the given input port.
vtkInformationVector* GetInputInformation(int port);
// Description:
// Get the pipeline information vectors for all inputs
vtkInformationVector** GetInputInformation();
// Description:
// Get the executive managing the given input connection.
vtkExecutive* GetInputExecutive(int port, int connection);
// Description:
// Get/Set the data object for an output port of the algorithm.
virtual vtkDataObject* GetOutputData(int port);
virtual void SetOutputData(int port, vtkDataObject*, vtkInformation *info);
virtual void SetOutputData(int port, vtkDataObject*);
// Description:
// Get the data object for an input port of the algorithm.
virtual vtkDataObject* GetInputData(int port, int connection);
virtual vtkDataObject* GetInputData(int port, int connection,
vtkInformationVector **inInfoVec);
// Description:
// Get the output port that produces the given data object.
virtual vtkAlgorithmOutput* GetProducerPort(vtkDataObject*);
// Description:
// Set a pointer to an outside instance of input or output
// information vectors. No references are held to the given
// vectors, and setting this does not change the executive object
// modification time. This is a preliminary interface to use in
// implementing filters with internal pipelines, and may change
// without notice when a future interface is created.
void SetSharedInputInformation(vtkInformationVector** inInfoVec);
void SetSharedOutputInformation(vtkInformationVector* outInfoVec);
// Description:
// Participate in garbage collection.
virtual void Register(vtkObjectBase* o);
virtual void UnRegister(vtkObjectBase* o);
// Description:
// Information key to store the executive/port number producing an
// information object.
static vtkInformationExecutivePortKey* PRODUCER();
// Description:
// Information key to store the executive/port number pairs
// consuming an information object.
static vtkInformationExecutivePortVectorKey* CONSUMERS();
// Description:
// Information key to store the output port number from which a
// request is made.
static vtkInformationIntegerKey* FROM_OUTPUT_PORT();
// Description:
// Keys to program vtkExecutive::ProcessRequest with the default
// behavior for unknown requests.
static vtkInformationIntegerKey* ALGORITHM_BEFORE_FORWARD();
static vtkInformationIntegerKey* ALGORITHM_AFTER_FORWARD();
static vtkInformationIntegerKey* ALGORITHM_DIRECTION();
static vtkInformationIntegerKey* FORWARD_DIRECTION();
static vtkInformationKeyVectorKey* KEYS_TO_COPY();
//BTX
enum { RequestUpstream, RequestDownstream };
enum { BeforeForward, AfterForward };
//ETX
// Description:
// An API to CallAlgorithm that allows you to pass in the info objects to
// be used
virtual int CallAlgorithm(vtkInformation* request, int direction,
vtkInformationVector** inInfo,
vtkInformationVector* outInfo);
protected:
vtkExecutive();
~vtkExecutive();
// Helper methods for subclasses.
int InputPortIndexInRange(int port, const char* action);
int OutputPortIndexInRange(int port, const char* action);
// Called by methods to check for a recursive pipeline update. A
// request should be fulfilled without making another request. This
// is used to help enforce that behavior. Returns 1 if no recursive
// request is occurring, and 0 otherwise. An error message is
// produced automatically if 0 is returned. The first argument is
// the name of the calling method (the one that should not be
// invoked recursively during an update). The second argument is
// the recursive request information object, if any. It is used to
// construct the error message.
int CheckAlgorithm(const char* method, vtkInformation* request);
virtual int ForwardDownstream(vtkInformation* request);
virtual int ForwardUpstream(vtkInformation* request);
virtual void CopyDefaultInformation(vtkInformation* request, int direction,
vtkInformationVector** inInfo,
vtkInformationVector* outInfo);
// Reset the pipeline update values in the given output information object.
virtual void ResetPipelineInformation(int port, vtkInformation*)=0;
// Bring the existence of output data objects up to date.
virtual int UpdateDataObject()=0;
// Garbage collection support.
virtual void ReportReferences(vtkGarbageCollector*);
virtual void SetAlgorithm(vtkAlgorithm* algorithm);
// The algorithm managed by this executive.
vtkAlgorithm* Algorithm;
// Flag set when the algorithm is processing a request.
int InAlgorithm;
// Pointers to an outside instance of input or output information.
// No references are held. These are used to implement internal
// pipelines.
vtkInformationVector** SharedInputInformation;
vtkInformationVector* SharedOutputInformation;
private:
// Store an information object for each output port of the algorithm.
vtkInformationVector* OutputInformation;
// Internal implementation details.
vtkExecutiveInternals* ExecutiveInternal;
//BTX
friend class vtkAlgorithmToExecutiveFriendship;
//ETX
private:
vtkExecutive(const vtkExecutive&); // Not implemented.
void operator=(const vtkExecutive&); // Not implemented.
};
#endif
|