VTK  9.2.20230606
vtkInformationStringKey.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkInformationStringKey.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 =========================================================================*/
26 #ifndef vtkInformationStringKey_h
27 #define vtkInformationStringKey_h
28 
29 #include "vtkCommonCoreModule.h" // For export macro
30 #include "vtkInformationKey.h"
31 
32 #include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
33 
34 #include <string> // for std::string compat
35 
36 VTK_ABI_NAMESPACE_BEGIN
37 class VTKCOMMONCORE_EXPORT vtkInformationStringKey : public vtkInformationKey
38 {
39 public:
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
43  vtkInformationStringKey(const char* name, const char* location);
45 
51  static VTK_NEWINSTANCE vtkInformationStringKey* MakeKey(const char* name, const char* location)
52  {
54  }
55 
57 
61  void Set(vtkInformation* info, const char*);
62  void Set(vtkInformation* info, const std::string& str);
63  const char* Get(vtkInformation* info);
65 
71  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
72 
76  void Print(ostream& os, vtkInformation* info) override;
77 
78 private:
80  void operator=(const vtkInformationStringKey&) = delete;
81 };
82 
83 VTK_ABI_NAMESPACE_END
84 #endif
a simple class to control print indentation
Definition: vtkIndent.h:120
Superclass for vtkInformation keys.
Key for string values in vtkInformation.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
~vtkInformationStringKey() override
static vtkInformationStringKey * MakeKey(const char *name, const char *location)
This method simply returns a new vtkInformationStringKey, given a name and a location.
void Set(vtkInformation *info, const std::string &str)
Get/Set the value associated with this key in the given information object.
vtkInformationStringKey(const char *name, const char *location)
void Set(vtkInformation *info, const char *)
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.
const char * Get(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
Store vtkAlgorithm input/output information.
@ location
Definition: vtkX3D.h:418
@ info
Definition: vtkX3D.h:388
@ name
Definition: vtkX3D.h:231
@ string
Definition: vtkX3D.h:502
#define VTK_NEWINSTANCE