1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkInformationObjectBaseVectorKey.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkInformationObjectBaseVectorKey
* @brief Key for vtkObjectBase vector values.
*
* vtkInformationObjectBaseVectorKey is used to represent keys for double
* vector values in vtkInformation.h. NOTE the interface in this key differs
* from that in other similar keys because of our internal use of smart
* pointers.
*/
#ifndef vtkInformationObjectBaseVectorKey_h
#define vtkInformationObjectBaseVectorKey_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkInformationKey.h"
#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
class vtkInformationObjectBaseVectorValue;
class VTKCOMMONCORE_EXPORT vtkInformationObjectBaseVectorKey : public vtkInformationKey
{
public:
vtkTypeMacro(vtkInformationObjectBaseVectorKey,vtkInformationKey);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@{
/**
* The name of the static instance and the class in which
* it is defined(location) should be passed to the constructor.
* Providing "requiredClass" name one can insure that only
* objects of type "requiredClass" are stored in vectors
* associated with the instance of this key type created.
* These should be string literals as they are not coppied.
*/
vtkInformationObjectBaseVectorKey(const char* name,
const char* location,
const char* requiredClass=0);
//
~vtkInformationObjectBaseVectorKey() VTK_OVERRIDE;
//@}
/**
* This method simply returns a new vtkInformationObjectBaseVectorKey, given a
* name, location and optionally a required class (a classname to restrict
* which class types can be set with this key). This method is provided
* for wrappers. Use the constructor directly from C++ instead.
*/
static vtkInformationObjectBaseVectorKey* MakeKey(const char* name, const char* location,
const char* requiredClass=0)
{
return new vtkInformationObjectBaseVectorKey(name, location, requiredClass);
}
/**
* Clear the vector.
*/
void Clear(vtkInformation* info);
/**
* Resize (extend) the vector to hold n objects. Any new elements
* created will be null initialized.
*/
void Resize(vtkInformation* info, int n);
/**
* Get the vector's length.
*/
int Size(vtkInformation* info);
int Length(vtkInformation* info){ return this->Size(info); }
/**
* Put the value on the back of the vector, with ref counting.
*/
void Append(vtkInformation* info, vtkObjectBase *value);
/**
* Set element i of the vector to value. Resizes the vector
* if needed.
*/
void Set(vtkInformation* info, vtkObjectBase *value, int i);
//@{
/**
* Remove all instances of val from the list. If using the indexed overload,
* the object at the specified position is removed.
*/
void Remove(vtkInformation *info, vtkObjectBase *val);
void Remove(vtkInformation *info, int idx);
using Superclass::Remove; // Don't hide base class methods
//@}
/**
* Copy n values from the range in source defined by [from from+n-1]
* into the range in this vector defined by [to to+n-1]. Resizes
* the vector if needed.
*/
void SetRange(vtkInformation* info,
vtkObjectBase **source,
int from,
int to,
int n);
/**
* Copy n values from the range in this vector defined by [from from+n-1]
* into the range in the destination vector defined by [to to+n-1]. Up
* to you to make sure the destination is big enough.
*/
void GetRange(vtkInformation *info,
vtkObjectBase **dest,
int from,
int to,
int n);
/**
* Get the vtkObjectBase at a specific location in the vector.
*/
vtkObjectBase *Get(vtkInformation* info, int idx);
// _escription:
// Get a pointer to the first vtkObjectBase in the vector. We are
// uysing a vector of smart pointers so this is not easy to
// implement.
// vtkObjectBase **Get(vtkInformation* info);
/**
* Copy the entry associated with this key from one information
* object to another. If there is no entry in the first information
* object for this key, the value is removed from the second.
*/
void ShallowCopy(vtkInformation* from, vtkInformation* to) VTK_OVERRIDE;
/**
* Print the key's value in an information object to a stream.
*/
void Print(ostream& os, vtkInformation* info) VTK_OVERRIDE;
protected:
// The type required of all objects stored with this key.
const char* RequiredClass;
private:
/**
* Used to create the underlying vector that will be associated
* with this key.
*/
void CreateObjectBase();
/**
* Check insures that if RequiredClass is set then the
* type of aValue matches. return true if the two match.
*/
bool ValidateDerivedType(vtkInformation* info,vtkObjectBase* aValue);
/**
* Get the vector associated with this key, if there is
* none then associate a new vector with this key and return
* that.
*/
vtkInformationObjectBaseVectorValue *GetObjectBaseVector(vtkInformation *info);
//
vtkInformationObjectBaseVectorKey(const vtkInformationObjectBaseVectorKey&) VTK_DELETE_FUNCTION;
void operator=(const vtkInformationObjectBaseVectorKey&) VTK_DELETE_FUNCTION;
};
#endif
|
