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=========================================================================*/
26#ifndef vtkInformationStringVectorKey_h
27#define vtkInformationStringVectorKey_h
28
29#include "vtkCommonCoreModule.h" // For export macro
30#include "vtkInformationKey.h"
31
32#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
33
34#include <string> // for std::string compat
35
36class VTKCOMMONCORE_EXPORT vtkInformationStringVectorKey : public vtkInformationKey
37{
38public:
40 void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
41
43 int length=-1);
45
51 static vtkInformationStringVectorKey* MakeKey(const char* name, const char* location,
52 int length=-1)
53 {
55 }
56
58
62 void Append(vtkInformation* info, const char* value);
63 void Set(vtkInformation* info, const char* value, int idx = 0);
65 void Set(vtkInformation* info, const std::string &value, int idx = 0);
66 const char* Get(vtkInformation* info, int idx = 0);
69
75 void ShallowCopy(vtkInformation* from, vtkInformation* to) VTK_OVERRIDE;
76
80 void Print(ostream& os, vtkInformation* info) VTK_OVERRIDE;
81
82protected:
83 // The required length of the vector value (-1 is no restriction).
85
86private:
88 void operator=(const vtkInformationStringVectorKey&) VTK_DELETE_FUNCTION;
89};
90
91#endif
a simple class to control print indentation
Definition: vtkIndent.h:40
Superclass for vtkInformation keys.
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
void Set(vtkInformation *info, const char *value, int idx=0)
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)
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)
void Append(vtkInformation *info, const std::string &value)
~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)
Store vtkAlgorithm input/output information.
@ location
Definition: vtkX3D.h:406
@ info
Definition: vtkX3D.h:376
@ length
Definition: vtkX3D.h:393
@ value
Definition: vtkX3D.h:220
@ name
Definition: vtkX3D.h:219
@ string
Definition: vtkX3D.h:490