VTK
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 
33 class VTKCOMMONCORE_EXPORT vtkInformationStringVectorKey : public vtkInformationKey
34 {
35 public:
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  {
51  }
52 
54 
58  void Append(vtkInformation* info, const char* value);
59  void Set(vtkInformation* info, const char* value, int idx = 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);
63  int Length(vtkInformation* info);
65 
71  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
72 
76  void Print(ostream& os, vtkInformation* info) override;
77 
78 protected:
79  // The required length of the vector value (-1 is no restriction).
81 
82 private:
84  void operator=(const vtkInformationStringVectorKey&) = delete;
85 };
86 
87 #endif
vtkCommonInformationKeyManager.h
vtkX3D::value
Definition: vtkX3D.h:226
vtkInformationStringVectorKey::RequiredLength
int RequiredLength
Definition: vtkInformationStringVectorKey.h:80
vtkX3D::length
Definition: vtkX3D.h:399
vtkInformationKey::Print
void Print(vtkInformation *info)
Print the key's value in an information object to a stream.
vtkInformationKey::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkX3D::name
Definition: vtkX3D.h:225
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:64
vtkX3D::info
Definition: vtkX3D.h:382
vtkX3D::string
Definition: vtkX3D.h:496
vtkInformationStringVectorKey
Key for String vector values.
Definition: vtkInformationStringVectorKey.h:33
vtkX3D::location
Definition: vtkX3D.h:412
vtkInformationStringVectorKey::MakeKey
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...
Definition: vtkInformationStringVectorKey.h:47
vtkInformationKey.h
vtkInformationKey
Superclass for vtkInformation keys.
Definition: vtkInformationKey.h:38
vtkInformationKey::ShallowCopy
virtual void ShallowCopy(vtkInformation *from, vtkInformation *to)=0
Copy the entry associated with this key from one information object to another.