VTK  9.3.20240226
vtkInformationExecutivePortVectorKey.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
12 #ifndef vtkInformationExecutivePortVectorKey_h
13 #define vtkInformationExecutivePortVectorKey_h
14 
15 #include "vtkCommonExecutionModelModule.h" // For export macro
16 #include "vtkInformationKey.h"
17 
18 #include "vtkFilteringInformationKeyManager.h" // Manage instances of this type.
19 
20 VTK_ABI_NAMESPACE_BEGIN
21 class vtkExecutive;
22 
23 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkInformationExecutivePortVectorKey : public vtkInformationKey
24 {
25 public:
27  void PrintSelf(ostream& os, vtkIndent indent) override;
28 
31 
38  const char* name, const char* location)
39  {
41  }
42 
44 
48  void Append(vtkInformation* info, vtkExecutive* executive, int port);
49  void Remove(vtkInformation* info, vtkExecutive* executive, int port);
50  void Set(vtkInformation* info, vtkExecutive** executives, int* ports, int length);
53  void Get(vtkInformation* info, vtkExecutive** executives, int* ports);
56 
62  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
63 
67  void Remove(vtkInformation* info) override;
68 
72  void Report(vtkInformation* info, vtkGarbageCollector* collector) override;
73 
77  void Print(ostream& os, vtkInformation* info) override;
78 
79 protected:
81 
89 
90 private:
92  void operator=(const vtkInformationExecutivePortVectorKey&) = delete;
93 };
94 
95 VTK_ABI_NAMESPACE_END
96 #endif
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:68
Detect and break reference loops.
a simple class to control print indentation
Definition: vtkIndent.h:108
Key for vtkExecutive/Port value pair vectors.
void Remove(vtkInformation *info, vtkExecutive *executive, int port)
Get/Set the value associated with this key in the given information object.
void Get(vtkInformation *info, vtkExecutive **executives, int *ports)
Get/Set the value associated with this key in the given information object.
int Length(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
vtkExecutive ** GetExecutivesWatchAddress(vtkInformation *info)
Get the address at which the actual value is stored.
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
vtkExecutive ** GetExecutives(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkInformationExecutivePortVectorKey * MakeKey(const char *name, const char *location)
This method simply returns a new vtkInformationExecutivePortVectorKey, given a name and a location.
void Append(vtkInformation *info, vtkExecutive *executive, int port)
Get/Set the value associated with this key in the given information object.
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
void Set(vtkInformation *info, vtkExecutive **executives, int *ports, int length)
Get/Set the value associated with this key in the given information object.
void Remove(vtkInformation *info) override
Remove this key from the given information object.
int * GetPortsWatchAddress(vtkInformation *info)
Get the address at which the actual value is stored.
void Report(vtkInformation *info, vtkGarbageCollector *collector) override
Report a reference this key has in the given information object.
vtkInformationExecutivePortVectorKey(const char *name, const char *location)
int * GetPorts(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
Superclass for vtkInformation keys.
Store vtkAlgorithm input/output information.
@ location
Definition: vtkX3D.h:406
@ info
Definition: vtkX3D.h:376
@ length
Definition: vtkX3D.h:393
@ port
Definition: vtkX3D.h:447
@ name
Definition: vtkX3D.h:219
#define VTK_NEWINSTANCE