VTK  9.1.20211016
vtkInformationExecutivePortKey.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkInformationExecutivePortKey.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 =========================================================================*/
24 #ifndef vtkInformationExecutivePortKey_h
25 #define vtkInformationExecutivePortKey_h
26 
27 #include "vtkCommonExecutionModelModule.h" // For export macro
28 #include "vtkInformationKey.h"
29 
30 #include "vtkFilteringInformationKeyManager.h" // Manage instances of this type.
31 
32 class vtkExecutive;
33 
34 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkInformationExecutivePortKey : public vtkInformationKey
35 {
36 public:
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39 
40  vtkInformationExecutivePortKey(const char* name, const char* location);
42 
48  static vtkInformationExecutivePortKey* MakeKey(const char* name, const char* location)
49  {
51  }
52 
54 
61  void Get(vtkInformation* info, vtkExecutive*& executive, int& port);
63 
69  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
70 
74  void Report(vtkInformation* info, vtkGarbageCollector* collector) override;
75 
79  void Print(ostream& os, vtkInformation* info) override;
80 
81 private:
83  void operator=(const vtkInformationExecutivePortKey&) = delete;
84 };
85 
86 #endif
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:76
Detect and break reference loops.
a simple class to control print indentation
Definition: vtkIndent.h:113
Key for vtkExecutive/Port value pairs.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void Get(vtkInformation *info, vtkExecutive *&executive, int &port)
Get/Set the value associated with this key in the given information object.
vtkInformationExecutivePortKey(const char *name, const char *location)
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
void Set(vtkInformation *info, vtkExecutive *, int)
Get/Set the value associated with this key in the given information object.
static vtkInformationExecutivePortKey * MakeKey(const char *name, const char *location)
This method simply returns a new vtkInformationExecutivePortKey, given a name and a location.
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
int GetPort(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
vtkExecutive * GetExecutive(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
void Report(vtkInformation *info, vtkGarbageCollector *collector) override
Report a reference this key has in the given information object.
~vtkInformationExecutivePortKey() override
Superclass for vtkInformation keys.
Store vtkAlgorithm input/output information.
@ location
Definition: vtkX3D.h:412
@ info
Definition: vtkX3D.h:382
@ port
Definition: vtkX3D.h:453
@ name
Definition: vtkX3D.h:225