VTK  9.3.20240622
vtkInformationStringKey.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
14#ifndef vtkInformationStringKey_h
15#define vtkInformationStringKey_h
16
17#include "vtkCommonCoreModule.h" // For export macro
18#include "vtkInformationKey.h"
19
20#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
21
22#include <string> // for std::string compat
23
24VTK_ABI_NAMESPACE_BEGIN
25class VTKCOMMONCORE_EXPORT vtkInformationStringKey : public vtkInformationKey
26{
27public:
29 void PrintSelf(ostream& os, vtkIndent indent) override;
30
31 vtkInformationStringKey(const char* name, const char* location);
33
39 static VTK_NEWINSTANCE vtkInformationStringKey* MakeKey(const char* name, const char* location)
40 {
41 return new vtkInformationStringKey(name, location);
42 }
43
45
49 void Set(vtkInformation* info, const char*);
50 void Set(vtkInformation* info, const std::string& str);
51 const char* Get(vtkInformation* info);
53
59 void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
60
64 void Print(ostream& os, vtkInformation* info) override;
65
66private:
68 void operator=(const vtkInformationStringKey&) = delete;
69};
70
71VTK_ABI_NAMESPACE_END
72#endif
a simple class to control print indentation
Definition vtkIndent.h:108
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.
const char * Get(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.
~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.
Store vtkAlgorithm input/output information.
#define VTK_NEWINSTANCE