VTK  9.3.20240419
vtkInformationVariantVectorKey.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
14 #ifndef vtkInformationVariantVectorKey_h
15 #define vtkInformationVariantVectorKey_h
16 
17 #include "vtkCommonCoreModule.h" // For export macro
18 #include "vtkInformationKey.h"
19 
20 #include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
21 
22 VTK_ABI_NAMESPACE_BEGIN
23 class vtkVariant;
24 
25 class VTKCOMMONCORE_EXPORT vtkInformationVariantVectorKey : public vtkInformationKey
26 {
27 public:
29  void PrintSelf(ostream& os, vtkIndent indent) override;
30 
31  vtkInformationVariantVectorKey(const char* name, const char* location, int length = -1);
33 
40  const char* name, const char* location, int length = -1)
41  {
43  }
44 
46 
53  const vtkVariant& Get(vtkInformation* info, int idx) const;
55  int Length(vtkInformation* info) const;
57 
63  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
64 
68  void Print(ostream& os, vtkInformation* info) override;
69 
70 protected:
71  // The required length of the vector value (-1 is no restriction).
73 
74 private:
76  void operator=(const vtkInformationVariantVectorKey&) = delete;
77 };
78 
79 VTK_ABI_NAMESPACE_END
80 #endif
a simple class to control print indentation
Definition: vtkIndent.h:108
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.
int Length(vtkInformation *info) const
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.
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.
const vtkVariant & Get(vtkInformation *info, int idx) 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 Append(vtkInformation *info, const vtkVariant &value)
Get/Set the value associated with this key in the given information object.
Store vtkAlgorithm input/output information.
A type representing the union of many types.
Definition: vtkVariant.h:162
@ 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
#define VTK_NEWINSTANCE