VTK
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 
40  vtkInformationExecutivePortVectorKey(const char* name, const char* location);
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);
61  vtkExecutive** GetExecutives(vtkInformation* info);
62  int* GetPorts(vtkInformation* info);
63  void Get(vtkInformation* info, vtkExecutive** executives, int* ports);
64  int Length(vtkInformation* info);
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:
90 
92 
97  vtkExecutive** GetExecutivesWatchAddress(vtkInformation* info);
98  int* GetPortsWatchAddress(vtkInformation* info);
100 
101 private:
103  void operator=(const vtkInformationExecutivePortVectorKey&) = delete;
104 };
105 
106 #endif
vtkInformationKey::Report
virtual void Report(vtkInformation *info, vtkGarbageCollector *collector)
Report a reference this key has in the given information object.
vtkX3D::length
Definition: vtkX3D.h:393
vtkFilteringInformationKeyManager.h
vtkX3D::port
Definition: vtkX3D.h:447
vtkExecutive
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:49
vtkInformationKey::Print
void Print(vtkInformation *info)
Print the key's value in an information object to a stream.
vtkInformationKey::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationExecutivePortVectorKey
Key for vtkExecutive/Port value pair vectors.
Definition: vtkInformationExecutivePortVectorKey.h:34
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkInformationKey::Remove
virtual void Remove(vtkInformation *info)
Remove this key from the given information object.
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
Definition: vtkX3D.h:219
vtkGarbageCollector
Detect and break reference loops.
Definition: vtkGarbageCollector.h:99
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:70
vtkX3D::info
Definition: vtkX3D.h:376
vtkX3D::location
Definition: vtkX3D.h:406
vtkInformationKey.h
vtkInformationKey
Superclass for vtkInformation keys.
Definition: vtkInformationKey.h:41
vtkInformationKey::ShallowCopy
virtual void ShallowCopy(vtkInformation *from, vtkInformation *to)=0
Copy the entry associated with this key from one information object to another.