VTK
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 =========================================================================*/
26 #ifndef vtkInformationVariantVectorKey_h
27 #define vtkInformationVariantVectorKey_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 class vtkVariant;
35 
36 class VTKCOMMONCORE_EXPORT vtkInformationVariantVectorKey : public vtkInformationKey
37 {
38 public:
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
42  vtkInformationVariantVectorKey(const char* name, const char* location,
43  int length=-1);
45 
51  static vtkInformationVariantVectorKey* MakeKey(const char* name, const char* location,
52  int length=-1)
53  {
55  }
56 
58 
62  void Append(vtkInformation* info, const vtkVariant& value);
63  void Set(vtkInformation* info, const vtkVariant* value, int length);
64  const vtkVariant* Get(vtkInformation* info) const;
65  const vtkVariant& Get(vtkInformation* info, int idx) const;
66  void Get(vtkInformation* info, vtkVariant* value) const;
67  int Length(vtkInformation* info) const;
69 
75  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
76 
80  void Print(ostream& os, vtkInformation* info) override;
81 
82 protected:
83  // The required length of the vector value (-1 is no restriction).
85 
86 private:
88  void operator=(const vtkInformationVariantVectorKey&) = delete;
89 };
90 
91 #endif
vtkCommonInformationKeyManager.h
vtkX3D::value
Definition: vtkX3D.h:220
vtkX3D::length
Definition: vtkX3D.h:393
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:39
vtkInformationVariantVectorKey
Key for variant vector values.
Definition: vtkInformationVariantVectorKey.h:36
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:71
vtkX3D::name
Definition: vtkX3D.h:219
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:70
vtkX3D::info
Definition: vtkX3D.h:376
vtkInformationVariantVectorKey::MakeKey
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...
Definition: vtkInformationVariantVectorKey.h:51
vtkX3D::location
Definition: vtkX3D.h:406
vtkInformationKey.h
vtkInformationKey
Superclass for vtkInformation keys.
Definition: vtkInformationKey.h:41
vtkInformationVariantVectorKey::RequiredLength
int RequiredLength
Definition: vtkInformationVariantVectorKey.h:84
vtkInformationKey::ShallowCopy
virtual void ShallowCopy(vtkInformation *from, vtkInformation *to)=0
Copy the entry associated with this key from one information object to another.