VTK  9.3.20240612
vtkInformationIntegerVectorKey.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 vtkInformationIntegerVectorKey_h
15#define vtkInformationIntegerVectorKey_h
16
17#include "vtkCommonCoreModule.h" // For export macro
18#include "vtkInformationKey.h"
19
20#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
21
22VTK_ABI_NAMESPACE_BEGIN
23class VTKCOMMONCORE_EXPORT vtkInformationIntegerVectorKey : public vtkInformationKey
24{
25public:
27 void PrintSelf(ostream& os, vtkIndent indent) override;
28
29 vtkInformationIntegerVectorKey(const char* name, const char* location, int length = -1);
31
38 const char* name, const char* location, int length = -1)
39 {
40 return new vtkInformationIntegerVectorKey(name, location, length);
41 }
42
44
48 void Append(vtkInformation* info, int value);
49 void Set(vtkInformation* info, const int* value, int length);
50 void Set(vtkInformation* info);
51 int* Get(vtkInformation* info);
52 int Get(vtkInformation* info, int idx);
53 void Get(vtkInformation* info, int* value);
56
62 void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
63
67 void Print(ostream& os, vtkInformation* info) override;
68
69protected:
70 // The required length of the vector value (-1 is no restriction).
72
79
80private:
82 void operator=(const vtkInformationIntegerVectorKey&) = delete;
83};
84
85VTK_ABI_NAMESPACE_END
86#endif
a simple class to control print indentation
Definition vtkIndent.h:108
~vtkInformationIntegerVectorKey() override
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
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...
int Get(vtkInformation *info, int idx)
Get/Set the value associated with this key in the given information object.
void Get(vtkInformation *info, int *value)
Get/Set the value associated with this key in the given information object.
int Length(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
void Append(vtkInformation *info, int value)
Get/Set the value associated with this key in the given information object.
int * Get(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
void Set(vtkInformation *info, const int *value, int length)
Get/Set the value associated with this key in the given information object.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationIntegerVectorKey(const char *name, const char *location, int length=-1)
int * GetWatchAddress(vtkInformation *info)
Get the address at which the actual value is stored.
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
void Set(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
Superclass for vtkInformation keys.
Store vtkAlgorithm input/output information.
#define VTK_NEWINSTANCE