VTK  9.1.0
vtkInformationVariantVectorKey.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkInformationVariantVectorKey.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 vtkInformationVariantVectorKey_h
24#define vtkInformationVariantVectorKey_h
25
26#include "vtkCommonCoreModule.h" // For export macro
27#include "vtkInformationKey.h"
28
29#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
30
31class vtkVariant;
32
33class VTKCOMMONCORE_EXPORT vtkInformationVariantVectorKey : public vtkInformationKey
34{
35public:
37 void PrintSelf(ostream& os, vtkIndent indent) override;
38
39 vtkInformationVariantVectorKey(const char* name, const char* location, int length = -1);
41
48 const char* name, const char* location, int length = -1)
49 {
50 return new vtkInformationVariantVectorKey(name, location, length);
51 }
52
54
58 void Append(vtkInformation* info, const vtkVariant& value);
59 void Set(vtkInformation* info, const vtkVariant* value, int length);
60 const vtkVariant* Get(vtkInformation* info) const;
61 const vtkVariant& Get(vtkInformation* info, int idx) const;
62 void Get(vtkInformation* info, vtkVariant* value) const;
63 int Length(vtkInformation* info) const;
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 vtkInformationVariantVectorKey&) = delete;
85};
86
87#endif
a simple class to control print indentation
Definition: vtkIndent.h:113
Superclass for vtkInformation keys.
vtkInformationVariantVectorKey(const char *name, const char *location, int length=-1)
void Set(vtkInformation *info, const vtkVariant *value, int length)
Get/Set the value associated with this key in the given information object.
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
const vtkVariant & Get(vtkInformation *info, int idx) const
Get/Set the value associated with this key in the given information object.
int Length(vtkInformation *info) const
Get/Set the value associated with this key in the given information object.
static vtkInformationVariantVectorKey * MakeKey(const char *name, const char *location, int length=-1)
This method simply returns a new vtkInformationVariantVectorKey, given a name, a location and a requi...
void Get(vtkInformation *info, vtkVariant *value) const
Get/Set the value associated with this key in the given information object.
~vtkInformationVariantVectorKey() override
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
void Append(vtkInformation *info, const vtkVariant &value)
Get/Set the value associated with this key in the given information object.
const vtkVariant * Get(vtkInformation *info) const
Get/Set the value associated with this key in the given information object.
Store vtkAlgorithm input/output information.
A atomic type representing the union of many types.
Definition: vtkVariant.h:145