VTK  9.0.20200919
vtkInformationIntegerVectorKey.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkInformationIntegerVectorKey.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 vtkInformationIntegerVectorKey_h
24 #define vtkInformationIntegerVectorKey_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 class VTKCOMMONCORE_EXPORT vtkInformationIntegerVectorKey : public vtkInformationKey
32 {
33 public:
35  void PrintSelf(ostream& os, vtkIndent indent) override;
36 
37  vtkInformationIntegerVectorKey(const char* name, const char* location, int length = -1);
39 
46  const char* name, const char* location, int length = -1)
47  {
49  }
50 
52 
56  void Append(vtkInformation* info, int value);
57  void Set(vtkInformation* info, const int* value, int length);
58  void Set(vtkInformation* info);
59  int* Get(vtkInformation* info);
60  int Get(vtkInformation* info, int idx);
61  void Get(vtkInformation* info, int* value);
62  int Length(vtkInformation* info);
64 
70  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
71 
75  void Print(ostream& os, vtkInformation* info) override;
76 
77 protected:
78  // The required length of the vector value (-1 is no restriction).
80 
86  int* GetWatchAddress(vtkInformation* info);
87 
88 private:
90  void operator=(const vtkInformationIntegerVectorKey&) = delete;
91 };
92 
93 #endif
vtkCommonInformationKeyManager.h
vtkX3D::value
Definition: vtkX3D.h:226
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
vtkInformationIntegerVectorKey::MakeKey
static vtkInformationIntegerVectorKey * MakeKey(const char *name, const char *location, int length=-1)
This method simply returns a new vtkInformationIntegerVectorKey, given a name, a location and a requi...
Definition: vtkInformationIntegerVectorKey.h:45
vtkX3D::name
Definition: vtkX3D.h:225
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkX3D::info
Definition: vtkX3D.h:382
vtkX3D::location
Definition: vtkX3D.h:412
vtkInformationIntegerVectorKey
Key for integer vector values.
Definition: vtkInformationIntegerVectorKey.h:31
vtkInformationKey.h
vtkInformationIntegerVectorKey::RequiredLength
int RequiredLength
Definition: vtkInformationIntegerVectorKey.h:79
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.