VTK  9.3.1
vtkInformationStringVectorKey.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 vtkInformationStringVectorKey_h
15 #define vtkInformationStringVectorKey_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 
24 VTK_ABI_NAMESPACE_BEGIN
25 class VTKCOMMONCORE_EXPORT vtkInformationStringVectorKey : public vtkInformationKey
26 {
27 public:
29  void PrintSelf(ostream& os, vtkIndent indent) override;
30 
31  vtkInformationStringVectorKey(const char* name, const char* location, int length = -1);
33 
40  const char* name, const char* location, int length = -1)
41  {
42  return new vtkInformationStringVectorKey(name, location, length);
43  }
44 
46 
50  void Append(vtkInformation* info, const char* value);
51  void Set(vtkInformation* info, const char* value, int index = 0);
52  void Append(vtkInformation* info, const std::string& value);
53  void Set(vtkInformation* info, const std::string& value, int idx = 0);
54  const char* Get(vtkInformation* info, int idx = 0);
55  int Length(vtkInformation* info);
57 
63  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
64 
68  void Print(ostream& os, vtkInformation* info) override;
69 
70 protected:
71  // The required length of the vector value (-1 is no restriction).
73 
74 private:
76  void operator=(const vtkInformationStringVectorKey&) = delete;
77 };
78 
79 VTK_ABI_NAMESPACE_END
80 #endif
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.
void Print(vtkInformation *info)
Print the key's value in an information object to a stream.
Superclass for vtkInformation keys.
a simple class to control print indentation
Definition: vtkIndent.h:28
Key for String vector values.
#define VTK_NEWINSTANCE
static vtkInformationStringVectorKey * MakeKey(const char *name, const char *location, int length=-1)
This method simply returns a new vtkInformationStringVectorKey, given a name, a location and a requir...