VTK  9.0.20210301
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 =========================================================================*/
23 #ifndef vtkInformationStringKey_h
24 #define vtkInformationStringKey_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 #include <string> // for std::string compat
32 
33 class VTKCOMMONCORE_EXPORT vtkInformationStringKey : public vtkInformationKey
34 {
35 public:
37  void PrintSelf(ostream& os, vtkIndent indent) override;
38 
39  vtkInformationStringKey(const char* name, const char* location);
41 
47  static vtkInformationStringKey* MakeKey(const char* name, const char* location)
48  {
50  }
51 
53 
57  void Set(vtkInformation* info, const char*);
58  void Set(vtkInformation* info, const std::string& str);
59  const char* Get(vtkInformation* info);
61 
67  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
68 
72  void Print(ostream& os, vtkInformation* info) override;
73 
74 private:
76  void operator=(const vtkInformationStringKey&) = delete;
77 };
78 
79 #endif
vtkInformationStringKey::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationStringKey::Get
const char * Get(vtkInformation *info)
vtkInformationStringKey
Key for string values in vtkInformation.
Definition: vtkInformationStringKey.h:34
vtkCommonInformationKeyManager.h
vtkInformationStringKey::MakeKey
static vtkInformationStringKey * MakeKey(const char *name, const char *location)
This method simply returns a new vtkInformationStringKey, given a name and a location.
Definition: vtkInformationStringKey.h:47
vtkInformationStringKey::ShallowCopy
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
vtkInformationStringKey::~vtkInformationStringKey
~vtkInformationStringKey() override
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkInformationStringKey::Set
void Set(vtkInformation *info, const char *)
Get/Set the value associated with this key in the given information object.
vtkX3D::name
@ name
Definition: vtkX3D.h:225
vtkInformationStringKey::vtkInformationStringKey
vtkInformationStringKey(const char *name, const char *location)
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:74
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkInformationStringKey::Print
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
vtkX3D::string
@ string
Definition: vtkX3D.h:496
vtkX3D::location
@ location
Definition: vtkX3D.h:412
vtkInformationKey.h
vtkInformationKey
Superclass for vtkInformation keys.
Definition: vtkInformationKey.h:39
vtkInformationStringKey::Set
void Set(vtkInformation *info, const std::string &str)