VTK
9.2.20220630
Common
Core
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
=========================================================================*/
26
#ifndef vtkInformationIntegerVectorKey_h
27
#define vtkInformationIntegerVectorKey_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
VTKCOMMONCORE_EXPORT
vtkInformationIntegerVectorKey
:
public
vtkInformationKey
35
{
36
public
:
37
vtkTypeMacro(
vtkInformationIntegerVectorKey
,
vtkInformationKey
);
38
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
39
40
vtkInformationIntegerVectorKey
(
const
char
*
name
,
const
char
*
location
,
int
length
= -1);
41
~vtkInformationIntegerVectorKey
()
override
;
42
48
static
VTK_NEWINSTANCE
vtkInformationIntegerVectorKey
*
MakeKey
(
49
const
char
*
name
,
const
char
*
location
,
int
length
= -1)
50
{
51
return
new
vtkInformationIntegerVectorKey
(
name
,
location
,
length
);
52
}
53
55
59
void
Append
(
vtkInformation
*
info
,
int
value
);
60
void
Set
(
vtkInformation
*
info
,
const
int
*
value
,
int
length
);
61
void
Set
(
vtkInformation
*
info
);
62
int
*
Get
(
vtkInformation
*
info
);
63
int
Get
(
vtkInformation
*
info
,
int
idx);
64
void
Get
(
vtkInformation
*
info
,
int
*
value
);
65
int
Length
(
vtkInformation
*
info
);
67
73
void
ShallowCopy
(
vtkInformation
* from,
vtkInformation
* to)
override
;
74
78
void
Print
(ostream& os,
vtkInformation
*
info
)
override
;
79
80
protected
:
81
// The required length of the vector value (-1 is no restriction).
82
int
RequiredLength
;
83
89
int
*
GetWatchAddress
(
vtkInformation
*
info
);
90
91
private
:
92
vtkInformationIntegerVectorKey
(
const
vtkInformationIntegerVectorKey
&) =
delete
;
93
void
operator=(
const
vtkInformationIntegerVectorKey
&) =
delete
;
94
};
95
96
#endif
vtkIndent
a simple class to control print indentation
Definition:
vtkIndent.h:119
vtkInformationIntegerVectorKey
Key for integer vector values.
Definition:
vtkInformationIntegerVectorKey.h:35
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:48
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:82
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:42
vtkInformation
Store vtkAlgorithm input/output information.
Definition:
vtkInformation.h:183
vtkX3D::location
@ location
Definition:
vtkX3D.h:412
vtkX3D::info
@ info
Definition:
vtkX3D.h:382
vtkX3D::length
@ length
Definition:
vtkX3D.h:399
vtkX3D::value
@ value
Definition:
vtkX3D.h:226
vtkX3D::name
@ name
Definition:
vtkX3D.h:225
vtkCommonInformationKeyManager.h
vtkInformationKey.h
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition:
vtkWrappingHints.h:44
Generated on Thu Jun 30 2022 06:38:03 for VTK by
1.9.1