VTK  9.3.1
vtkInformationExecutivePortKey.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 vtkInformationExecutivePortKey_h
13 #define vtkInformationExecutivePortKey_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 vtkInformationExecutivePortKey : public vtkInformationKey
24 {
25 public:
27  void PrintSelf(ostream& os, vtkIndent indent) override;
28 
29  vtkInformationExecutivePortKey(const char* name, const char* location);
31 
38  const char* name, const char* location)
39  {
40  return new vtkInformationExecutivePortKey(name, location);
41  }
42 
44 
48  void Set(vtkInformation* info, vtkExecutive*, int);
49  vtkExecutive* GetExecutive(vtkInformation* info);
50  int GetPort(vtkInformation* info);
51  void Get(vtkInformation* info, vtkExecutive*& executive, int& port);
53 
59  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
60 
64  void Report(vtkInformation* info, vtkGarbageCollector* collector) override;
65 
69  void Print(ostream& os, vtkInformation* info) override;
70 
71 private:
73  void operator=(const vtkInformationExecutivePortKey&) = delete;
74 };
75 
76 VTK_ABI_NAMESPACE_END
77 #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.
static vtkInformationExecutivePortKey * MakeKey(const char *name, const char *location)
This method simply returns a new vtkInformationExecutivePortKey, given a name and a location...
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.
a simple class to control print indentation
Definition: vtkIndent.h:28
#define VTK_NEWINSTANCE
Key for vtkExecutive/Port value pairs.