VTK  9.0.20210621
vtkInformationExecutivePortVectorKey.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkInformationExecutivePortVectorKey.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 vtkInformationExecutivePortVectorKey_h
25 #define vtkInformationExecutivePortVectorKey_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 vtkInformationExecutivePortVectorKey : public vtkInformationKey
35 {
36 public:
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39 
42 
48  static vtkInformationExecutivePortVectorKey* MakeKey(const char* name, const char* location)
49  {
51  }
52 
54 
58  void Append(vtkInformation* info, vtkExecutive* executive, int port);
59  void Remove(vtkInformation* info, vtkExecutive* executive, int port);
60  void Set(vtkInformation* info, vtkExecutive** executives, int* ports, int length);
63  void Get(vtkInformation* info, vtkExecutive** executives, int* ports);
66 
72  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
73 
77  void Remove(vtkInformation* info) override;
78 
82  void Report(vtkInformation* info, vtkGarbageCollector* collector) override;
83 
87  void Print(ostream& os, vtkInformation* info) override;
88 
89 protected:
91 
99 
100 private:
102  void operator=(const vtkInformationExecutivePortVectorKey&) = delete;
103 };
104 
105 #endif
vtkInformationExecutivePortVectorKey::GetExecutivesWatchAddress
vtkExecutive ** GetExecutivesWatchAddress(vtkInformation *info)
Get the address at which the actual value is stored.
vtkInformationExecutivePortVectorKey::Get
void Get(vtkInformation *info, vtkExecutive **executives, int *ports)
Get/Set the value associated with this key in the given information object.
vtkX3D::length
@ length
Definition: vtkX3D.h:399
vtkInformationExecutivePortVectorKey::GetPorts
int * GetPorts(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
vtkInformationExecutivePortVectorKey::Length
int Length(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
vtkFilteringInformationKeyManager.h
vtkInformationExecutivePortVectorKey::Print
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
vtkInformationExecutivePortVectorKey::Remove
void Remove(vtkInformation *info, vtkExecutive *executive, int port)
Get/Set the value associated with this key in the given information object.
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkExecutive
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:47
vtkInformationExecutivePortVectorKey::Report
void Report(vtkInformation *info, vtkGarbageCollector *collector) override
Report a reference this key has in the given information object.
vtkInformationExecutivePortVectorKey
Key for vtkExecutive/Port value pair vectors.
Definition: vtkInformationExecutivePortVectorKey.h:35
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkInformationExecutivePortVectorKey::GetPortsWatchAddress
int * GetPortsWatchAddress(vtkInformation *info)
Get the address at which the actual value is stored.
vtkInformationExecutivePortVectorKey::vtkInformationExecutivePortVectorKey
vtkInformationExecutivePortVectorKey(const char *name, const char *location)
vtkInformationExecutivePortVectorKey::MakeKey
static vtkInformationExecutivePortVectorKey * MakeKey(const char *name, const char *location)
This method simply returns a new vtkInformationExecutivePortVectorKey, given a name and a location.
Definition: vtkInformationExecutivePortVectorKey.h:48
vtkX3D::name
@ name
Definition: vtkX3D.h:225
vtkGarbageCollector
Detect and break reference loops.
Definition: vtkGarbageCollector.h:95
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:74
vtkInformationExecutivePortVectorKey::~vtkInformationExecutivePortVectorKey
~vtkInformationExecutivePortVectorKey() override
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkInformationExecutivePortVectorKey::Append
void Append(vtkInformation *info, vtkExecutive *executive, int port)
Get/Set the value associated with this key in the given information object.
vtkInformationExecutivePortVectorKey::Remove
void Remove(vtkInformation *info) override
Remove this key from the given information object.
vtkInformationExecutivePortVectorKey::ShallowCopy
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
vtkInformationExecutivePortVectorKey::Set
void Set(vtkInformation *info, vtkExecutive **executives, int *ports, int length)
Get/Set the value associated with this key in the given information object.
vtkX3D::location
@ location
Definition: vtkX3D.h:412
vtkInformationKey.h
vtkInformationKey
Superclass for vtkInformation keys.
Definition: vtkInformationKey.h:39
vtkInformationExecutivePortVectorKey::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationExecutivePortVectorKey::GetExecutives
vtkExecutive ** GetExecutives(vtkInformation *info)
Get/Set the value associated with this key in the given information object.