VTK
9.3.20240419
Common
Core
vtkInformationStringVectorKey.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 vtkInformationStringVectorKey_h
15
#define vtkInformationStringVectorKey_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
#include <string>
// for std::string compat
23
24
VTK_ABI_NAMESPACE_BEGIN
25
class
VTKCOMMONCORE_EXPORT
vtkInformationStringVectorKey
:
public
vtkInformationKey
26
{
27
public
:
28
vtkTypeMacro(
vtkInformationStringVectorKey
,
vtkInformationKey
);
29
void
PrintSelf
(ostream& os,
vtkIndent
indent)
override
;
30
31
vtkInformationStringVectorKey
(
const
char
*
name
,
const
char
*
location
,
int
length
= -1);
32
~vtkInformationStringVectorKey
()
override
;
33
39
static
VTK_NEWINSTANCE
vtkInformationStringVectorKey
*
MakeKey
(
40
const
char
*
name
,
const
char
*
location
,
int
length
= -1)
41
{
42
return
new
vtkInformationStringVectorKey
(
name
,
location
,
length
);
43
}
44
46
50
void
Append
(
vtkInformation
*
info
,
const
char
*
value
);
51
void
Set
(
vtkInformation
*
info
,
const
char
*
value
,
int
index
= 0);
52
void
Append
(
vtkInformation
*
info
,
const
std::string
&
value
);
53
void
Set
(
vtkInformation
*
info
,
const
std::string
&
value
,
int
idx = 0);
54
const
char
*
Get
(
vtkInformation
*
info
,
int
idx = 0);
55
int
Length
(
vtkInformation
*
info
);
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).
72
int
RequiredLength
;
73
74
private
:
75
vtkInformationStringVectorKey
(
const
vtkInformationStringVectorKey
&) =
delete
;
76
void
operator=(
const
vtkInformationStringVectorKey
&) =
delete
;
77
};
78
79
VTK_ABI_NAMESPACE_END
80
#endif
vtkIndent
a simple class to control print indentation
Definition:
vtkIndent.h:108
vtkInformationKey
Superclass for vtkInformation keys.
Definition:
vtkInformationKey.h:31
vtkInformationStringVectorKey
Key for String vector values.
Definition:
vtkInformationStringVectorKey.h:26
vtkInformationStringVectorKey::Set
void Set(vtkInformation *info, const char *value, int index=0)
Get/Set the value associated with this key in the given information object.
vtkInformationStringVectorKey::Print
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
vtkInformationStringVectorKey::ShallowCopy
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
vtkInformationStringVectorKey::Set
void Set(vtkInformation *info, const std::string &value, int idx=0)
Get/Set the value associated with this key in the given information object.
vtkInformationStringVectorKey::Get
const char * Get(vtkInformation *info, int idx=0)
Get/Set the value associated with this key in the given information object.
vtkInformationStringVectorKey::MakeKey
static vtkInformationStringVectorKey * MakeKey(const char *name, const char *location, int length=-1)
This method simply returns a new vtkInformationStringVectorKey, given a name, a location and a requir...
Definition:
vtkInformationStringVectorKey.h:39
vtkInformationStringVectorKey::Append
void Append(vtkInformation *info, const char *value)
Get/Set the value associated with this key in the given information object.
vtkInformationStringVectorKey::Append
void Append(vtkInformation *info, const std::string &value)
Get/Set the value associated with this key in the given information object.
vtkInformationStringVectorKey::~vtkInformationStringVectorKey
~vtkInformationStringVectorKey() override
vtkInformationStringVectorKey::vtkInformationStringVectorKey
vtkInformationStringVectorKey(const char *name, const char *location, int length=-1)
vtkInformationStringVectorKey::RequiredLength
int RequiredLength
Definition:
vtkInformationStringVectorKey.h:72
vtkInformationStringVectorKey::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationStringVectorKey::Length
int Length(vtkInformation *info)
Get/Set the value associated with this key in the given information object.
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
vtkX3D::index
@ index
Definition:
vtkX3D.h:246
vtkX3D::string
@ string
Definition:
vtkX3D.h:490
vtkCommonInformationKeyManager.h
vtkInformationKey.h
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition:
vtkWrappingHints.h:42
Generated on Fri Apr 19 2024 10:38:03 for VTK by
1.9.1