VTK
9.3.20240417
Common
Core
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
22
VTK_ABI_NAMESPACE_BEGIN
23
class
VTKCOMMONCORE_EXPORT
vtkInformationIntegerVectorKey
:
public
vtkInformationKey
24
{
25
public
:
26
vtkTypeMacro(
vtkInformationIntegerVectorKey
,
vtkInformationKey
);
27
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
28
29
vtkInformationIntegerVectorKey
(
const
char
*
name
,
const
char
*
location
,
int
length
= -1);
30
~vtkInformationIntegerVectorKey
()
override
;
31
37
static
VTK_NEWINSTANCE
vtkInformationIntegerVectorKey
*
MakeKey
(
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
);
54
int
Length
(
vtkInformation
*
info
);
56
62
void
ShallowCopy
(
vtkInformation
* from,
vtkInformation
* to)
override
;
63
67
void
Print
(ostream& os,
vtkInformation
*
info
)
override
;
68
69
protected
:
70
// The required length of the vector value (-1 is no restriction).
71
int
RequiredLength
;
72
78
int
*
GetWatchAddress
(
vtkInformation
*
info
);
79
80
private
:
81
vtkInformationIntegerVectorKey
(
const
vtkInformationIntegerVectorKey
&) =
delete
;
82
void
operator=(
const
vtkInformationIntegerVectorKey
&) =
delete
;
83
};
84
85
VTK_ABI_NAMESPACE_END
86
#endif
vtkIndent
a simple class to control print indentation
Definition:
vtkIndent.h:108
vtkInformationIntegerVectorKey
Key for integer vector values.
Definition:
vtkInformationIntegerVectorKey.h:24
vtkInformationIntegerVectorKey::~vtkInformationIntegerVectorKey
~vtkInformationIntegerVectorKey() override
vtkInformationIntegerVectorKey::Print
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
vtkInformationIntegerVectorKey::Get
int Get(vtkInformation *info, int idx)
Get/Set the value associated with this key in the given information object.
vtkInformationIntegerVectorKey::Get
void Get(vtkInformation *info, int *value)
Get/Set the value associated with this key in the given information object.
vtkInformationIntegerVectorKey::Get
int * Get(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
vtkInformationIntegerVectorKey::Length
int Length(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
vtkInformationIntegerVectorKey::Append
void Append(vtkInformation *info, int value)
Get/Set the value associated with this key in the given information object.
vtkInformationIntegerVectorKey::Set
void Set(vtkInformation *info, const int *value, int length)
Get/Set the value associated with this key in the given information object.
vtkInformationIntegerVectorKey::GetWatchAddress
int * GetWatchAddress(vtkInformation *info)
Get the address at which the actual value is stored.
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:37
vtkInformationIntegerVectorKey::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationIntegerVectorKey::vtkInformationIntegerVectorKey
vtkInformationIntegerVectorKey(const char *name, const char *location, int length=-1)
vtkInformationIntegerVectorKey::RequiredLength
int RequiredLength
Definition:
vtkInformationIntegerVectorKey.h:71
vtkInformationIntegerVectorKey::ShallowCopy
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
vtkInformationIntegerVectorKey::Set
void Set(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
vtkInformationKey
Superclass for vtkInformation keys.
Definition:
vtkInformationKey.h:31
vtkInformation
Store vtkAlgorithm input/output information.
Definition:
vtkInformation.h:172
vtkX3D::location
@ location
Definition:
vtkX3D.h:406
vtkX3D::info
@ info
Definition:
vtkX3D.h:376
vtkX3D::length
@ length
Definition:
vtkX3D.h:393
vtkX3D::value
@ value
Definition:
vtkX3D.h:220
vtkX3D::name
@ name
Definition:
vtkX3D.h:219
vtkCommonInformationKeyManager.h
vtkInformationKey.h
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition:
vtkWrappingHints.h:42
Generated on Wed Apr 17 2024 08:24:40 for VTK by
1.9.1