VTK  9.3.1
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 
29  vtkInformationExecutivePortVectorKey(const char* name, const char* location);
31 
38  const char* name, const char* location)
39  {
40  return new vtkInformationExecutivePortVectorKey(name, location);
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);
51  vtkExecutive** GetExecutives(vtkInformation* info);
52  int* GetPorts(vtkInformation* info);
53  void Get(vtkInformation* info, vtkExecutive** executives, int* ports);
54  int Length(vtkInformation* info);
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 
86  vtkExecutive** GetExecutivesWatchAddress(vtkInformation* info);
87  int* GetPortsWatchAddress(vtkInformation* info);
89 
90 private:
92  void operator=(const vtkInformationExecutivePortVectorKey&) = delete;
93 };
94 
95 VTK_ABI_NAMESPACE_END
96 #endif
virtual void Report(vtkInformation *info, vtkGarbageCollector *collector)
Report a reference this key has in the given information object.
virtual void ShallowCopy(vtkInformation *from, vtkInformation *to)=0
Copy the entry associated with this key from one information object to another.
Store vtkAlgorithm input/output information.
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:38
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
Detect and break reference loops.
void Print(vtkInformation *info)
Print the key's value in an information object to a stream.
Superclass for vtkInformation keys.
virtual void Remove(vtkInformation *info)
Remove this key from the given information object.
static vtkInformationExecutivePortVectorKey * MakeKey(const char *name, const char *location)
This method simply returns a new vtkInformationExecutivePortVectorKey, given a name and a location...
a simple class to control print indentation
Definition: vtkIndent.h:28
Key for vtkExecutive/Port value pair vectors.
#define VTK_NEWINSTANCE