VTK: Common/Core/vtkInformationDataObjectKey.h Source File

| VTK 9.3.1

vtkInformationDataObjectKey.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
11 #ifndef vtkInformationDataObjectKey_h
12 #define vtkInformationDataObjectKey_h
13
14 #include "vtkCommonCoreModule.h" // For export macro
15 #include "vtkInformationKey.h"
16
17 #include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
18
19 VTK_ABI_NAMESPACE_BEGIN
20 class vtkDataObject;
21
22 class VTKCOMMONCORE_EXPORT vtkInformationDataObjectKey : public vtkInformationKey
23 {
24 public:
25 vtkTypeMacro(vtkInformationDataObjectKey, vtkInformationKey);
26 void PrintSelf(ostream& os, vtkIndent indent) override;
27
28 vtkInformationDataObjectKey(const char* name, const char* location);
29 ~vtkInformationDataObjectKey() override;
30
36 static VTK_NEWINSTANCE vtkInformationDataObjectKey* MakeKey(
37 const char* name, const char* location)
38 {
39 return new vtkInformationDataObjectKey(name, location);
40 }
41
43
47 void Set(vtkInformation* info, vtkDataObject*);
48 vtkDataObject* Get(vtkInformation* info);
50
56 void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
57
61 void Report(vtkInformation* info, vtkGarbageCollector* collector) override;
62
63 private:
64 vtkInformationDataObjectKey(const vtkInformationDataObjectKey&) = delete;
65 void operator=(const vtkInformationDataObjectKey&) = delete;
66 };
67
68 VTK_ABI_NAMESPACE_END
69 #endif
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkGarbageCollector
Detect and break reference loops.
Definition: vtkGarbageCollector.h:80
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:38
vtkInformationDataObjectKey
Key for vtkDataObject values.
Definition: vtkInformationDataObjectKey.h:23
vtkInformationDataObjectKey::ShallowCopy
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
vtkInformationDataObjectKey::vtkInformationDataObjectKey
vtkInformationDataObjectKey(const char *name, const char *location)
vtkInformationDataObjectKey::Report
void Report(vtkInformation *info, vtkGarbageCollector *collector) override
Report a reference this key has in the given information object.
vtkInformationDataObjectKey::MakeKey
static vtkInformationDataObjectKey * MakeKey(const char *name, const char *location)
This method simply returns a new vtkInformationDataObjectKey, given a name and a location.
Definition: vtkInformationDataObjectKey.h:36
vtkInformationDataObjectKey::~vtkInformationDataObjectKey
~vtkInformationDataObjectKey() override
vtkInformationDataObjectKey::Set
void Set(vtkInformation *info, vtkDataObject *)
Get/Set the value associated with this key in the given information object.
vtkInformationDataObjectKey::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationDataObjectKey::Get
vtkDataObject * Get(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
vtkInformationKey
Superclass for vtkInformation keys.
Definition: vtkInformationKey.h:31
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:72
vtkX3D::location
@ location
Definition: vtkX3D.h:406
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkCommonInformationKeyManager.h
vtkInformationKey.h
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition: vtkWrappingHints.h:32