forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkInformationObjectBaseKey.h
87 lines (69 loc) · 2.86 KB
/
vtkInformationObjectBaseKey.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*=========================================================================
Program: Visualization Toolkit
Module: vtkInformationObjectBaseKey.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkInformationObjectBaseKey
* @brief Key for vtkObjectBase values.
*
* vtkInformationObjectBaseKey is used to represent keys in
* vtkInformation for values that are vtkObjectBase instances.
*/
#ifndef vtkInformationObjectBaseKey_h
#define vtkInformationObjectBaseKey_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkInformationKey.h"
#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
class vtkObjectBase;
class VTKCOMMONCORE_EXPORT vtkInformationObjectBaseKey : public vtkInformationKey
{
public:
vtkTypeMacro(vtkInformationObjectBaseKey, vtkInformationKey);
void PrintSelf(ostream& os, vtkIndent indent) override;
vtkInformationObjectBaseKey(
const char* name, const char* location, const char* requiredClass = nullptr);
~vtkInformationObjectBaseKey() override;
/**
* This method simply returns a new vtkInformationObjectBaseKey, given a
* name, location and optionally a required class (a classname to restrict
* which class types can be set with this key). This method is provided
* for wrappers. Use the constructor directly from C++ instead.
*/
static vtkInformationObjectBaseKey* MakeKey(
const char* name, const char* location, const char* requiredClass = nullptr)
{
return new vtkInformationObjectBaseKey(name, location, requiredClass);
}
///@{
/**
* Get/Set the value associated with this key in the given
* information object.
*/
void Set(vtkInformation* info, vtkObjectBase*);
vtkObjectBase* Get(vtkInformation* info);
///@}
/**
* Copy the entry associated with this key from one information
* object to another. If there is no entry in the first information
* object for this key, the value is removed from the second.
*/
void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
/**
* Report a reference this key has in the given information object.
*/
void Report(vtkInformation* info, vtkGarbageCollector* collector) override;
protected:
// The type required of all objects stored with this key.
const char* RequiredClass;
vtkInformationKeySetStringMacro(RequiredClass);
private:
vtkInformationObjectBaseKey(const vtkInformationObjectBaseKey&) = delete;
void operator=(const vtkInformationObjectBaseKey&) = delete;
};
#endif