VTK  9.3.20241004
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
20VTK_ABI_NAMESPACE_BEGIN
21class vtkExecutive;
22
23class VTKCOMMONEXECUTIONMODEL_EXPORT vtkInformationExecutivePortVectorKey : public vtkInformationKey
24{
25public:
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);
53 void Get(vtkInformation* info, vtkExecutive** executives, int* ports);
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
79protected:
81
89
90private:
92 void operator=(const vtkInformationExecutivePortVectorKey&) = delete;
93};
94
95VTK_ABI_NAMESPACE_END
96#endif
Superclass for all pipeline executives in VTK.
Detect and break reference loops.
a simple class to control print indentation
Definition vtkIndent.h:108
Key for vtkExecutive/Port value pair vectors.
void Remove(vtkInformation *info, vtkExecutive *executive, int port)
Get/Set the value associated with this key in the given information object.
void Get(vtkInformation *info, vtkExecutive **executives, int *ports)
Get/Set the value associated with this key in the given information object.
int Length(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
vtkExecutive ** GetExecutives(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void Append(vtkInformation *info, vtkExecutive *executive, int port)
Get/Set the value associated with this key in the given information object.
int * GetPorts(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
void Set(vtkInformation *info, vtkExecutive **executives, int *ports, int length)
Get/Set the value associated with this key in the given information object.
void Remove(vtkInformation *info) override
Remove this key from the given information object.
void Report(vtkInformation *info, vtkGarbageCollector *collector) override
Report a reference this key has in the given information object.
vtkExecutive ** GetExecutivesWatchAddress(vtkInformation *info)
Get the address at which the actual value is stored.
int * GetPortsWatchAddress(vtkInformation *info)
Get the address at which the actual value is stored.
vtkInformationExecutivePortVectorKey(const char *name, const char *location)
static vtkInformationExecutivePortVectorKey * MakeKey(const char *name, const char *location)
This method simply returns a new vtkInformationExecutivePortVectorKey, given a name and a location.
Superclass for vtkInformation keys.
Store vtkAlgorithm input/output information.
#define VTK_NEWINSTANCE