VTK
vtkInformationObjectBaseKey.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkInformationObjectBaseKey.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 =========================================================================*/
23 #ifndef vtkInformationObjectBaseKey_h
24 #define vtkInformationObjectBaseKey_h
25 
26 #include "vtkCommonCoreModule.h" // For export macro
27 #include "vtkInformationKey.h"
28 
29 #include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
30 
31 class vtkObjectBase;
32 
33 class VTKCOMMONCORE_EXPORT vtkInformationObjectBaseKey : public vtkInformationKey
34 {
35 public:
37  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
38 
39  vtkInformationObjectBaseKey(const char* name, const char* location,
40  const char* requiredClass=0);
41  ~vtkInformationObjectBaseKey() VTK_OVERRIDE;
42 
49  static vtkInformationObjectBaseKey* MakeKey(const char* name, const char* location,
50  const char* requiredClass=0)
51  {
52  return new vtkInformationObjectBaseKey(name, location, requiredClass);
53  }
54 
56 
60  void Set(vtkInformation* info, vtkObjectBase*);
63 
69  void ShallowCopy(vtkInformation* from, vtkInformation* to) VTK_OVERRIDE;
70 
74  void Report(vtkInformation* info, vtkGarbageCollector* collector) VTK_OVERRIDE;
75 
76 protected:
77  // The type required of all objects stored with this key.
78  const char* RequiredClass;
79 
80  vtkInformationKeySetStringMacro(RequiredClass);
81 
82 private:
83  vtkInformationObjectBaseKey(const vtkInformationObjectBaseKey&) VTK_DELETE_FUNCTION;
84  void operator=(const vtkInformationObjectBaseKey&) VTK_DELETE_FUNCTION;
85 };
86 
87 #endif
virtual void Report(vtkInformation *info, vtkGarbageCollector *collector)
Report a reference this key has in the given information object.
virtual void ShallowCopy(vtkInformation *from, vtkInformation *to)=0
Copy the entry associated with this key from one information object to another.
Store vtkAlgorithm input/output information.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
Detect and break reference loops.
Superclass for vtkInformation keys.
a simple class to control print indentation
Definition: vtkIndent.h:33
Key for vtkObjectBase values.
abstract base class for most VTK objects
Definition: vtkObjectBase.h:62
vtkInformationKeySetStringMacro(Name)