VTK  9.1.0
vtkInformationStringVectorKey.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkInformationStringVectorKey.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 vtkInformationStringVectorKey_h
24#define vtkInformationStringVectorKey_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
33class VTKCOMMONCORE_EXPORT vtkInformationStringVectorKey : public vtkInformationKey
34{
35public:
37 void PrintSelf(ostream& os, vtkIndent indent) override;
38
39 vtkInformationStringVectorKey(const char* name, const char* location, int length = -1);
41
48 const char* name, const char* location, int length = -1)
49 {
50 return new vtkInformationStringVectorKey(name, location, length);
51 }
52
54
58 void Append(vtkInformation* info, const char* value);
59 void Set(vtkInformation* info, const char* value, int index = 0);
60 void Append(vtkInformation* info, const std::string& value);
61 void Set(vtkInformation* info, const std::string& value, int idx = 0);
62 const char* Get(vtkInformation* info, int idx = 0);
65
71 void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
72
76 void Print(ostream& os, vtkInformation* info) override;
77
78protected:
79 // The required length of the vector value (-1 is no restriction).
81
82private:
84 void operator=(const vtkInformationStringVectorKey&) = delete;
85};
86
87#endif
a simple class to control print indentation
Definition: vtkIndent.h:113
Superclass for vtkInformation keys.
void Set(vtkInformation *info, const char *value, int index=0)
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.
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
void Set(vtkInformation *info, const std::string &value, int idx=0)
Get/Set the value associated with this key in the given information object.
void Append(vtkInformation *info, const char *value)
Get/Set the value associated with this key in the given information object.
const char * Get(vtkInformation *info, int idx=0)
Get/Set the value associated with this key in the given information object.
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...
void Append(vtkInformation *info, const std::string &value)
Get/Set the value associated with this key in the given information object.
~vtkInformationStringVectorKey() override
vtkInformationStringVectorKey(const char *name, const char *location, int length=-1)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int Length(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
Store vtkAlgorithm input/output information.