VTK: Common/Core/vtkInformation.h Source File

| VTK 9.3.1

vtkInformation.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
34 #ifndef vtkInformation_h
35 #define vtkInformation_h
36
37 #include "vtkCommonCoreModule.h" // For export macro
38 #include "vtkObject.h"
39
40 #include <string> // for std::string compat
41
42 VTK_ABI_NAMESPACE_BEGIN
43 class vtkDataObject;
44 class vtkExecutive;
45 class vtkInformationDataObjectKey;
46 class vtkInformationDoubleKey;
47 class vtkInformationDoubleVectorKey;
48 class vtkInformationExecutivePortKey;
49 class vtkInformationExecutivePortVectorKey;
50 class vtkInformationIdTypeKey;
51 class vtkInformationInformationKey;
52 class vtkInformationInformationVectorKey;
53 class vtkInformationIntegerKey;
54 class vtkInformationIntegerPointerKey;
55 class vtkInformationIntegerVectorKey;
56 class vtkInformationInternals;
57 class vtkInformationKey;
58 class vtkInformationKeyToInformationFriendship;
59 class vtkInformationKeyVectorKey;
60 class vtkInformationObjectBaseKey;
61 class vtkInformationObjectBaseVectorKey;
62 class vtkInformationRequestKey;
63 class vtkInformationStringKey;
64 class vtkInformationStringVectorKey;
65 class vtkInformationUnsignedLongKey;
66 class vtkInformationVariantKey;
67 class vtkInformationVariantVectorKey;
68 class vtkInformationVector;
69 class vtkVariant;
70
71 class VTKCOMMONCORE_EXPORT vtkInformation : public vtkObject
72 {
73 public:
74 static vtkInformation* New();
75 vtkTypeMacro(vtkInformation, vtkObject);
76 void PrintSelf(ostream& os, vtkIndent indent) override;
77 void PrintKeys(ostream& os, vtkIndent indent);
78
83 void Modified() override;
84
90 void Modified(vtkInformationKey* key);
91
95 void Clear();
96
101 int GetNumberOfKeys();
102
110 void Copy(vtkInformation* from, vtkTypeBool deep = 0);
111
118 void Append(vtkInformation* from, vtkTypeBool deep = 0);
119
121
127 void CopyEntry(vtkInformation* from, vtkInformationKey* key, vtkTypeBool deep = 0);
128 void CopyEntry(vtkInformation* from, vtkInformationDataObjectKey* key, vtkTypeBool deep = 0);
129 void CopyEntry(vtkInformation* from, vtkInformationDoubleVectorKey* key, vtkTypeBool deep = 0);
130 void CopyEntry(vtkInformation* from, vtkInformationVariantKey* key, vtkTypeBool deep = 0);
131 void CopyEntry(vtkInformation* from, vtkInformationVariantVectorKey* key, vtkTypeBool deep = 0);
132 void CopyEntry(vtkInformation* from, vtkInformationInformationKey* key, vtkTypeBool deep = 0);
133 void CopyEntry(
134 vtkInformation* from, vtkInformationInformationVectorKey* key, vtkTypeBool deep = 0);
135 void CopyEntry(vtkInformation* from, vtkInformationIntegerKey* key, vtkTypeBool deep = 0);
136 void CopyEntry(vtkInformation* from, vtkInformationIntegerVectorKey* key, vtkTypeBool deep = 0);
137 void CopyEntry(
138 vtkInformation* from, vtkInformationObjectBaseVectorKey* key, vtkTypeBool deep = 0);
139 void CopyEntry(vtkInformation* from, vtkInformationRequestKey* key, vtkTypeBool deep = 0);
140 void CopyEntry(vtkInformation* from, vtkInformationStringKey* key, vtkTypeBool deep = 0);
141 void CopyEntry(vtkInformation* from, vtkInformationStringVectorKey* key, vtkTypeBool deep = 0);
142 void CopyEntry(vtkInformation* from, vtkInformationUnsignedLongKey* key, vtkTypeBool deep = 0);
144
151 void CopyEntries(vtkInformation* from, vtkInformationKeyVectorKey* key, vtkTypeBool deep = 0);
152
156 int Has(vtkInformationKey* key);
157
161 void Remove(vtkInformationKey* key);
162
164
167 void Set(vtkInformationRequestKey* key);
168 void Remove(vtkInformationRequestKey* key);
169 int Has(vtkInformationRequestKey* key);
171
173
176 void Set(vtkInformationIntegerKey* key, int value);
177 int Get(vtkInformationIntegerKey* key);
178 void Remove(vtkInformationIntegerKey* key);
179 int Has(vtkInformationIntegerKey* key);
181
183
186 void Set(vtkInformationIdTypeKey* key, vtkIdType value);
187 vtkIdType Get(vtkInformationIdTypeKey* key);
188 void Remove(vtkInformationIdTypeKey* key);
189 int Has(vtkInformationIdTypeKey* key);
191
193
196 void Set(vtkInformationDoubleKey* key, double value);
197 double Get(vtkInformationDoubleKey* key);
198 void Remove(vtkInformationDoubleKey* key);
199 int Has(vtkInformationDoubleKey* key);
201
203
206 void Set(vtkInformationVariantKey* key, const vtkVariant& value);
207 const vtkVariant& Get(vtkInformationVariantKey* key);
208 void Remove(vtkInformationVariantKey* key);
209 int Has(vtkInformationVariantKey* key);
211
213
216 void Append(vtkInformationIntegerVectorKey* key, int value);
217 void Set(vtkInformationIntegerVectorKey* key, const int* value, int length);
218 void Set(vtkInformationIntegerVectorKey* key, int value1, int value2, int value3);
219 void Set(vtkInformationIntegerVectorKey* key, int value1, int value2, int value3, int value4,
220 int value5, int value6);
221 int* Get(vtkInformationIntegerVectorKey* key);
222 int Get(vtkInformationIntegerVectorKey* key, int idx);
223 void Get(vtkInformationIntegerVectorKey* key, int* value);
224 int Length(vtkInformationIntegerVectorKey* key);
225 void Remove(vtkInformationIntegerVectorKey* key);
226 int Has(vtkInformationIntegerVectorKey* key);
228
230
233 void Append(vtkInformationStringVectorKey* key, const char* value);
234 void Set(vtkInformationStringVectorKey* key, const char* value, int idx = 0);
235 void Append(vtkInformationStringVectorKey* key, const std::string& value);
236 void Set(vtkInformationStringVectorKey* key, const std::string& value, int idx = 0);
237 const char* Get(vtkInformationStringVectorKey* key, int idx = 0);
238 int Length(vtkInformationStringVectorKey* key);
239 void Remove(vtkInformationStringVectorKey* key);
240 int Has(vtkInformationStringVectorKey* key);
242
244
247 void Set(vtkInformationIntegerPointerKey* key, int* value, int length);
248 int* Get(vtkInformationIntegerPointerKey* key);
249 void Get(vtkInformationIntegerPointerKey* key, int* value);
250 int Length(vtkInformationIntegerPointerKey* key);
251 void Remove(vtkInformationIntegerPointerKey* key);
252 int Has(vtkInformationIntegerPointerKey* key);
254
256
259 void Set(vtkInformationUnsignedLongKey* key, unsigned long value);
260 unsigned long Get(vtkInformationUnsignedLongKey* key);
261 void Remove(vtkInformationUnsignedLongKey* key);
262 int Has(vtkInformationUnsignedLongKey* key);
264
266
269 void Append(vtkInformationDoubleVectorKey* key, double value);
270 void Set(vtkInformationDoubleVectorKey* key, const double* value, int length);
271 void Set(vtkInformationDoubleVectorKey* key, double value1, double value2, double value3);
272 void Set(vtkInformationDoubleVectorKey* key, double value1, double value2, double value3,
273 double value4, double value5, double value6);
274 double* Get(vtkInformationDoubleVectorKey* key);
275 double Get(vtkInformationDoubleVectorKey* key, int idx);
276 void Get(vtkInformationDoubleVectorKey* key, double* value);
277 int Length(vtkInformationDoubleVectorKey* key);
278 void Remove(vtkInformationDoubleVectorKey* key);
279 int Has(vtkInformationDoubleVectorKey* key);
281
283
286 void Append(vtkInformationVariantVectorKey* key, const vtkVariant& value);
287 void Set(vtkInformationVariantVectorKey* key, const vtkVariant* value, int length);
288 void Set(vtkInformationVariantVectorKey* key, const vtkVariant& value1, const vtkVariant& value2,
289 const vtkVariant& value3);
290 void Set(vtkInformationVariantVectorKey* key, const vtkVariant& value1, const vtkVariant& value2,
291 const vtkVariant& value3, const vtkVariant& value4, const vtkVariant& value5,
292 const vtkVariant& value6);
293 const vtkVariant* Get(vtkInformationVariantVectorKey* key);
294 const vtkVariant& Get(vtkInformationVariantVectorKey* key, int idx);
295 void Get(vtkInformationVariantVectorKey* key, vtkVariant* value);
296 int Length(vtkInformationVariantVectorKey* key);
297 void Remove(vtkInformationVariantVectorKey* key);
298 int Has(vtkInformationVariantVectorKey* key);
300
302
305 void Append(vtkInformationKeyVectorKey* key, vtkInformationKey* value);
306 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationKey* value);
307 void Set(vtkInformationKeyVectorKey* key, vtkInformationKey* const* value, int length);
308 void Remove(vtkInformationKeyVectorKey* key, vtkInformationKey* value);
309 vtkInformationKey** Get(vtkInformationKeyVectorKey* key);
310 vtkInformationKey* Get(vtkInformationKeyVectorKey* key, int idx);
311 void Get(vtkInformationKeyVectorKey* key, vtkInformationKey** value);
312 int Length(vtkInformationKeyVectorKey* key);
313 void Remove(vtkInformationKeyVectorKey* key);
314 int Has(vtkInformationKeyVectorKey* key);
316
317 // Provide extra overloads of this method to avoid requiring user
318 // code to include the headers for these key types. Avoid wrapping
319 // them because the original method can be called from the wrappers
320 // anyway and this causes a python help string to be too long.
321
322 void Append(vtkInformationKeyVectorKey* key, vtkInformationDataObjectKey* value);
323 void Append(vtkInformationKeyVectorKey* key, vtkInformationDoubleKey* value);
324 void Append(vtkInformationKeyVectorKey* key, vtkInformationDoubleVectorKey* value);
325 void Append(vtkInformationKeyVectorKey* key, vtkInformationInformationKey* value);
326 void Append(vtkInformationKeyVectorKey* key, vtkInformationInformationVectorKey* value);
327 void Append(vtkInformationKeyVectorKey* key, vtkInformationIntegerKey* value);
328 void Append(vtkInformationKeyVectorKey* key, vtkInformationIntegerVectorKey* value);
329 void Append(vtkInformationKeyVectorKey* key, vtkInformationStringKey* value);
330 void Append(vtkInformationKeyVectorKey* key, vtkInformationStringVectorKey* value);
331 void Append(vtkInformationKeyVectorKey* key, vtkInformationObjectBaseKey* value);
332 void Append(vtkInformationKeyVectorKey* key, vtkInformationUnsignedLongKey* value);
333
334 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationDataObjectKey* value);
335 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationDoubleKey* value);
336 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationDoubleVectorKey* value);
337 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationInformationKey* value);
338 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationInformationVectorKey* value);
339 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationIntegerKey* value);
340 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationIntegerVectorKey* value);
341 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationStringKey* value);
342 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationStringVectorKey* value);
343 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationObjectBaseKey* value);
344 void AppendUnique(vtkInformationKeyVectorKey* key, vtkInformationUnsignedLongKey* value);
345
347
350 void Set(vtkInformationStringKey* key, const char*);
351 void Set(vtkInformationStringKey* key, const std::string&);
352 const char* Get(vtkInformationStringKey* key);
353 void Remove(vtkInformationStringKey* key);
354 int Has(vtkInformationStringKey* key);
356
358
361 void Set(vtkInformationInformationKey* key, vtkInformation*);
362 vtkInformation* Get(vtkInformationInformationKey* key);
363 void Remove(vtkInformationInformationKey* key);
364 int Has(vtkInformationInformationKey* key);
366
368
371 void Set(vtkInformationInformationVectorKey* key, vtkInformationVector*);
372 vtkInformationVector* Get(vtkInformationInformationVectorKey* key);
373 void Remove(vtkInformationInformationVectorKey* key);
374 int Has(vtkInformationInformationVectorKey* key);
376
378
381 void Set(vtkInformationObjectBaseKey* key, vtkObjectBase*);
382 vtkObjectBase* Get(vtkInformationObjectBaseKey* key);
383 void Remove(vtkInformationObjectBaseKey* key);
384 int Has(vtkInformationObjectBaseKey* key);
386
388
391 void Append(vtkInformationObjectBaseVectorKey* key, vtkObjectBase* data);
392 void Set(vtkInformationObjectBaseVectorKey* key, vtkObjectBase* value, int idx = 0);
393 vtkObjectBase* Get(vtkInformationObjectBaseVectorKey* key, int idx = 0);
394 int Length(vtkInformationObjectBaseVectorKey* key);
395 void Remove(vtkInformationObjectBaseVectorKey* key);
396 void Remove(vtkInformationObjectBaseVectorKey* key, vtkObjectBase* objectToRemove);
397 void Remove(vtkInformationObjectBaseVectorKey* key, int indexToRemove);
398 int Has(vtkInformationObjectBaseVectorKey* key);
400
402
405 void Set(vtkInformationDataObjectKey* key, vtkDataObject VTK_WRAP_EXTERN*);
406 vtkDataObject VTK_WRAP_EXTERN* Get(vtkInformationDataObjectKey* key);
407 void Remove(vtkInformationDataObjectKey* key);
408 int Has(vtkInformationDataObjectKey* key);
410
412
415 static vtkInformationKey* GetKey(vtkInformationDataObjectKey* key);
416 static vtkInformationKey* GetKey(vtkInformationDoubleKey* key);
417 static vtkInformationKey* GetKey(vtkInformationDoubleVectorKey* key);
418 static vtkInformationKey* GetKey(vtkInformationInformationKey* key);
419 static vtkInformationKey* GetKey(vtkInformationInformationVectorKey* key);
420 static vtkInformationKey* GetKey(vtkInformationIntegerKey* key);
421 static vtkInformationKey* GetKey(vtkInformationIntegerVectorKey* key);
422 static vtkInformationKey* GetKey(vtkInformationRequestKey* key);
423 static vtkInformationKey* GetKey(vtkInformationStringKey* key);
424 static vtkInformationKey* GetKey(vtkInformationStringVectorKey* key);
425 static vtkInformationKey* GetKey(vtkInformationKey* key);
426 static vtkInformationKey* GetKey(vtkInformationUnsignedLongKey* key);
427 static vtkInformationKey* GetKey(vtkInformationVariantKey* key);
428 static vtkInformationKey* GetKey(vtkInformationVariantVectorKey* key);
430
432
435 bool UsesGarbageCollector() const override { return true; }
437
439
442 void SetRequest(vtkInformationRequestKey* request);
443 vtkInformationRequestKey* GetRequest();
445
446 protected:
447 vtkInformation();
448 ~vtkInformation() override;
449
450 // Get/Set a map entry directly through the vtkObjectBase instance
451 // representing the value. Used internally to manage the map.
452 void SetAsObjectBase(vtkInformationKey* key, vtkObjectBase* value);
453 const vtkObjectBase* GetAsObjectBase(const vtkInformationKey* key) const;
454 vtkObjectBase* GetAsObjectBase(vtkInformationKey* key);
455
456 // Internal implementation details.
457 vtkInformationInternals* Internal;
458
459 // Garbage collection support.
460 void ReportReferences(vtkGarbageCollector*) override;
461
462 // Report the object associated with the given key to the collector.
463 void ReportAsObjectBase(vtkInformationKey* key, vtkGarbageCollector* collector);
464
465 private:
466 friend class vtkInformationKeyToInformationFriendship;
467 friend class vtkInformationIterator;
468
469 vtkInformation(const vtkInformation&) = delete;
470 void operator=(const vtkInformation&) = delete;
471 vtkInformationRequestKey* Request;
472 };
473
474 VTK_ABI_NAMESPACE_END
475 #endif
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkExecutive
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:48
vtkGarbageCollector
Detect and break reference loops.
Definition: vtkGarbageCollector.h:80
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:38
vtkInformationDataObjectKey
Key for vtkDataObject values.
Definition: vtkInformationDataObjectKey.h:23
vtkInformationDoubleKey
Key for double values in vtkInformation.
Definition: vtkInformationDoubleKey.h:24
vtkInformationDoubleVectorKey
Key for double vector values.
Definition: vtkInformationDoubleVectorKey.h:33
vtkInformationExecutivePortKey
Key for vtkExecutive/Port value pairs.
Definition: vtkInformationExecutivePortKey.h:24
vtkInformationExecutivePortVectorKey
Key for vtkExecutive/Port value pair vectors.
Definition: vtkInformationExecutivePortVectorKey.h:24
vtkInformationIdTypeKey
Key for vtkIdType values in vtkInformation.
Definition: vtkInformationIdTypeKey.h:24
vtkInformationInformationKey
Key for vtkInformation values.
Definition: vtkInformationInformationKey.h:21
vtkInformationInformationVectorKey
Key for vtkInformation vectors.
Definition: vtkInformationInformationVectorKey.h:23
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:24
vtkInformationIntegerPointerKey
Key for pointer to integer.
Definition: vtkInformationIntegerPointerKey.h:21
vtkInformationIntegerVectorKey
Key for integer vector values.
Definition: vtkInformationIntegerVectorKey.h:24
vtkInformationInternals
internal structure for vtkInformation
Definition: vtkInformationInternals.h:29
vtkInformationIterator
Iterates over keys of an information object.
Definition: vtkInformationIterator.h:30
vtkInformationKeyVectorKey
Key for vector-of-keys values.
Definition: vtkInformationKeyVectorKey.h:21
vtkInformationKey
Superclass for vtkInformation keys.
Definition: vtkInformationKey.h:31
vtkInformationObjectBaseKey
Key for vtkObjectBase values.
Definition: vtkInformationObjectBaseKey.h:26
vtkInformationObjectBaseVectorKey
Key for vtkObjectBase vector values.
Definition: vtkInformationObjectBaseVectorKey.h:24
vtkInformationRequestKey
Key for pointer to pointer.
Definition: vtkInformationRequestKey.h:21
vtkInformationStringKey
Key for string values in vtkInformation.
Definition: vtkInformationStringKey.h:26
vtkInformationStringVectorKey
Key for String vector values.
Definition: vtkInformationStringVectorKey.h:26
vtkInformationUnsignedLongKey
Key for unsigned long values in vtkInformation.
Definition: vtkInformationUnsignedLongKey.h:24
vtkInformationVariantKey
Key for variant values in vtkInformation.
Definition: vtkInformationVariantKey.h:26
vtkInformationVariantVectorKey
Key for variant vector values.
Definition: vtkInformationVariantVectorKey.h:26
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:40
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:72
vtkInformation::Remove
void Remove(vtkInformationObjectBaseKey *key)
Get/Set an entry storing a vtkObjectBase instance.
vtkInformation::Has
int Has(vtkInformationVariantKey *key)
Get/Set an variant-valued entry.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationInformationKey *key)
Upcast the given key instance.
vtkInformation::Get
void Get(vtkInformationDoubleVectorKey *key, double *value)
Get/Set an double-vector-valued entry.
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationKey *value)
Get/Set an InformationKey-vector-valued entry.
vtkInformation::Set
void Set(vtkInformationInformationVectorKey *key, vtkInformationVector *)
Get/Set an entry storing a vtkInformationVector instance.
vtkInformation::Append
void Append(vtkInformationStringVectorKey *key, const char *value)
Get/Set a string-vector-valued entry.
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationStringKey *value)
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationInformationVectorKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationDoubleVectorKey *value)
vtkInformation::Remove
void Remove(vtkInformationUnsignedLongKey *key)
Get/Set an unsigned-long-valued entry.
vtkInformation::Set
void Set(vtkInformationIntegerVectorKey *key, int value1, int value2, int value3)
Get/Set an integer-vector-valued entry.
vtkInformation::Set
void Set(vtkInformationDoubleVectorKey *key, double value1, double value2, double value3)
Get/Set an double-vector-valued entry.
vtkInformation::Get
int Get(vtkInformationIntegerKey *key)
Get/Set an integer-valued entry.
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationDoubleKey *value)
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationObjectBaseKey *value)
vtkInformation::Has
int Has(vtkInformationObjectBaseKey *key)
Get/Set an entry storing a vtkObjectBase instance.
vtkInformation::Get
void Get(vtkInformationIntegerVectorKey *key, int *value)
Get/Set an integer-vector-valued entry.
vtkInformation::Get
vtkDataObject VTK_WRAP_EXTERN * Get(vtkInformationDataObjectKey *key)
Get/Set an entry storing a vtkDataObject instance.
vtkInformation::Remove
void Remove(vtkInformationDoubleVectorKey *key)
Get/Set an double-vector-valued entry.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationDoubleVectorKey *key)
Upcast the given key instance.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Set
void Set(vtkInformationVariantVectorKey *key, const vtkVariant &value1, const vtkVariant &value2, const vtkVariant &value3, const vtkVariant &value4, const vtkVariant &value5, const vtkVariant &value6)
Get/Set an variant-vector-valued entry.
vtkInformation::Set
void Set(vtkInformationKeyVectorKey *key, vtkInformationKey *const *value, int length)
Get/Set an InformationKey-vector-valued entry.
vtkInformation::Set
void Set(vtkInformationIntegerVectorKey *key, int value1, int value2, int value3, int value4, int value5, int value6)
Get/Set an integer-vector-valued entry.
vtkInformation::Get
double * Get(vtkInformationDoubleVectorKey *key)
Get/Set an double-vector-valued entry.
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationObjectBaseKey *value)
vtkInformation::Set
void Set(vtkInformationIntegerPointerKey *key, int *value, int length)
Get/Set an integer-pointer-valued entry.
vtkInformation::Get
const vtkVariant & Get(vtkInformationVariantVectorKey *key, int idx)
Get/Set an variant-vector-valued entry.
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationStringVectorKey *value)
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationUnsignedLongKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Get
vtkInformationVector * Get(vtkInformationInformationVectorKey *key)
Get/Set an entry storing a vtkInformationVector instance.
vtkInformation::Set
void Set(vtkInformationIntegerVectorKey *key, const int *value, int length)
Get/Set an integer-vector-valued entry.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationIntegerKey *key)
Upcast the given key instance.
vtkInformation::Set
void Set(vtkInformationObjectBaseVectorKey *key, vtkObjectBase *value, int idx=0)
Manipulate a ObjectBaseVector entry.
vtkInformation::Has
int Has(vtkInformationDoubleKey *key)
Get/Set an double-valued entry.
vtkInformation::Remove
void Remove(vtkInformationKey *key)
Remove the given key and its data from this information object.
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationIntegerVectorKey *value)
vtkInformation::ReportAsObjectBase
void ReportAsObjectBase(vtkInformationKey *key, vtkGarbageCollector *collector)
vtkInformation::Set
void Set(vtkInformationInformationKey *key, vtkInformation *)
Get/Set an entry storing another vtkInformation instance.
vtkInformation::Get
double Get(vtkInformationDoubleKey *key)
Get/Set an double-valued entry.
vtkInformation::Remove
void Remove(vtkInformationVariantVectorKey *key)
Get/Set an variant-vector-valued entry.
vtkInformation::Has
int Has(vtkInformationInformationVectorKey *key)
Get/Set an entry storing a vtkInformationVector instance.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationDataObjectKey *key)
Upcast the given key instance.
vtkInformation::Length
int Length(vtkInformationVariantVectorKey *key)
Get/Set an variant-vector-valued entry.
vtkInformation::Append
void Append(vtkInformationDoubleVectorKey *key, double value)
Get/Set an double-vector-valued entry.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationVariantVectorKey *key)
Upcast the given key instance.
vtkInformation::SetRequest
void SetRequest(vtkInformationRequestKey *request)
Get/Set the Request ivar.
vtkInformation::Set
void Set(vtkInformationObjectBaseKey *key, vtkObjectBase *)
Get/Set an entry storing a vtkObjectBase instance.
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationUnsignedLongKey *value)
vtkInformation::Modified
void Modified() override
Modified signature with no arguments that calls Modified on vtkObject superclass.
vtkInformation::GetAsObjectBase
vtkObjectBase * GetAsObjectBase(vtkInformationKey *key)
vtkInformation::Get
const vtkVariant * Get(vtkInformationVariantVectorKey *key)
Get/Set an variant-vector-valued entry.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationUnsignedLongKey *key)
Upcast the given key instance.
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationInformationVectorKey *value)
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationStringKey *key)
Upcast the given key instance.
vtkInformation::Length
int Length(vtkInformationKeyVectorKey *key)
Get/Set an InformationKey-vector-valued entry.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationInformationKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Set
void Set(vtkInformationDoubleKey *key, double value)
Get/Set an double-valued entry.
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationIntegerVectorKey *value)
vtkInformation::Length
int Length(vtkInformationDoubleVectorKey *key)
Get/Set an double-vector-valued entry.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationIntegerVectorKey *key)
Upcast the given key instance.
vtkInformation::Get
vtkInformation * Get(vtkInformationInformationKey *key)
Get/Set an entry storing another vtkInformation instance.
vtkInformation::GetAsObjectBase
const vtkObjectBase * GetAsObjectBase(const vtkInformationKey *key) const
vtkInformation::Set
void Set(vtkInformationStringKey *key, const char *)
Get/Set a string-valued entry.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationVariantKey *key)
Upcast the given key instance.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationIntegerKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Get
void Get(vtkInformationKeyVectorKey *key, vtkInformationKey **value)
Get/Set an InformationKey-vector-valued entry.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationDataObjectKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Has
int Has(vtkInformationDataObjectKey *key)
Get/Set an entry storing a vtkDataObject instance.
vtkInformation::Get
void Get(vtkInformationIntegerPointerKey *key, int *value)
Get/Set an integer-pointer-valued entry.
vtkInformation::Set
void Set(vtkInformationVariantKey *key, const vtkVariant &value)
Get/Set an variant-valued entry.
vtkInformation::~vtkInformation
~vtkInformation() override
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationDoubleVectorKey *value)
vtkInformation::Set
void Set(vtkInformationVariantVectorKey *key, const vtkVariant *value, int length)
Get/Set an variant-vector-valued entry.
vtkInformation::Remove
void Remove(vtkInformationStringKey *key)
Get/Set a string-valued entry.
vtkInformation::Get
const char * Get(vtkInformationStringVectorKey *key, int idx=0)
Get/Set a string-vector-valued entry.
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationInformationKey *value)
vtkInformation::GetRequest
vtkInformationRequestKey * GetRequest()
Get/Set the Request ivar.
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationKey *value)
Get/Set an InformationKey-vector-valued entry.
vtkInformation::Get
vtkInformationKey * Get(vtkInformationKeyVectorKey *key, int idx)
Get/Set an InformationKey-vector-valued entry.
vtkInformation::Remove
void Remove(vtkInformationKeyVectorKey *key)
Get/Set an InformationKey-vector-valued entry.
vtkInformation::Remove
void Remove(vtkInformationObjectBaseVectorKey *key, int indexToRemove)
Manipulate a ObjectBaseVector entry.
vtkInformation::Remove
void Remove(vtkInformationInformationKey *key)
Get/Set an entry storing another vtkInformation instance.
vtkInformation::ReportReferences
void ReportReferences(vtkGarbageCollector *) override
vtkInformation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformation::Remove
void Remove(vtkInformationObjectBaseVectorKey *key)
Manipulate a ObjectBaseVector entry.
vtkInformation::Clear
void Clear()
Clear all information entries.
vtkInformation::Has
int Has(vtkInformationUnsignedLongKey *key)
Get/Set an unsigned-long-valued entry.
vtkInformation::Has
int Has(vtkInformationIdTypeKey *key)
Get/Set a vtkIdType-valued entry.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationVariantKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationUnsignedLongKey *value)
vtkInformation::Has
int Has(vtkInformationStringVectorKey *key)
Get/Set a string-vector-valued entry.
vtkInformation::Set
void Set(vtkInformationDoubleVectorKey *key, double value1, double value2, double value3, double value4, double value5, double value6)
Get/Set an double-vector-valued entry.
vtkInformation::Get
vtkIdType Get(vtkInformationIdTypeKey *key)
Get/Set a vtkIdType-valued entry.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationRequestKey *key)
Upcast the given key instance.
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationInformationVectorKey *value)
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationIntegerVectorKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Get
const char * Get(vtkInformationStringKey *key)
Get/Set a string-valued entry.
vtkInformation::Remove
void Remove(vtkInformationIntegerPointerKey *key)
Get/Set an integer-pointer-valued entry.
vtkInformation::Has
int Has(vtkInformationVariantVectorKey *key)
Get/Set an variant-vector-valued entry.
vtkInformation::Remove
void Remove(vtkInformationVariantKey *key)
Get/Set an variant-valued entry.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationVariantVectorKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Append
void Append(vtkInformationIntegerVectorKey *key, int value)
Get/Set an integer-vector-valued entry.
vtkInformation::Append
void Append(vtkInformationStringVectorKey *key, const std::string &value)
Get/Set a string-vector-valued entry.
vtkInformation::Get
vtkObjectBase * Get(vtkInformationObjectBaseVectorKey *key, int idx=0)
Manipulate a ObjectBaseVector entry.
vtkInformation::Remove
void Remove(vtkInformationIntegerVectorKey *key)
Get/Set an integer-vector-valued entry.
vtkInformation::Set
void Set(vtkInformationDoubleVectorKey *key, const double *value, int length)
Get/Set an double-vector-valued entry.
vtkInformation::Set
void Set(vtkInformationStringVectorKey *key, const std::string &value, int idx=0)
Get/Set a string-vector-valued entry.
vtkInformation::Remove
void Remove(vtkInformationDoubleKey *key)
Get/Set an double-valued entry.
vtkInformation::GetNumberOfKeys
int GetNumberOfKeys()
Return the number of keys in this information object (as would be returned by iterating over the keys...
vtkInformation::Get
vtkInformationKey ** Get(vtkInformationKeyVectorKey *key)
Get/Set an InformationKey-vector-valued entry.
vtkInformation::Remove
void Remove(vtkInformationInformationVectorKey *key)
Get/Set an entry storing a vtkInformationVector instance.
vtkInformation::Modified
void Modified(vtkInformationKey *key)
Modified signature that takes an information key as an argument.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationStringKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationDataObjectKey *value)
vtkInformation::Has
int Has(vtkInformationIntegerPointerKey *key)
Get/Set an integer-pointer-valued entry.
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationStringKey *value)
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationDataObjectKey *value)
vtkInformation::Internal
vtkInformationInternals * Internal
Definition: vtkInformation.h:457
vtkInformation::SetAsObjectBase
void SetAsObjectBase(vtkInformationKey *key, vtkObjectBase *value)
vtkInformation::Append
void Append(vtkInformationObjectBaseVectorKey *key, vtkObjectBase *data)
Manipulate a ObjectBaseVector entry.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationDoubleVectorKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Get
int * Get(vtkInformationIntegerPointerKey *key)
Get/Set an integer-pointer-valued entry.
vtkInformation::CopyEntries
void CopyEntries(vtkInformation *from, vtkInformationKeyVectorKey *key, vtkTypeBool deep=0)
Use the given key to lookup a list of other keys in the given information object.
vtkInformation::UsesGarbageCollector
bool UsesGarbageCollector() const override
Initiate garbage collection when a reference is removed.
Definition: vtkInformation.h:435
vtkInformation::Has
int Has(vtkInformationRequestKey *key)
Get/Set a request-valued entry.
vtkInformation::Set
void Set(vtkInformationUnsignedLongKey *key, unsigned long value)
Get/Set an unsigned-long-valued entry.
vtkInformation::Set
void Set(vtkInformationRequestKey *key)
Get/Set a request-valued entry.
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationDoubleKey *value)
vtkInformation::Get
void Get(vtkInformationVariantVectorKey *key, vtkVariant *value)
Get/Set an variant-vector-valued entry.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationDoubleKey *key)
Upcast the given key instance.
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationStringVectorKey *value)
vtkInformation::vtkInformation
vtkInformation()
vtkInformation::Length
int Length(vtkInformationIntegerVectorKey *key)
Get/Set an integer-vector-valued entry.
vtkInformation::Has
int Has(vtkInformationIntegerKey *key)
Get/Set an integer-valued entry.
vtkInformation::Get
int * Get(vtkInformationIntegerVectorKey *key)
Get/Set an integer-vector-valued entry.
vtkInformation::Has
int Has(vtkInformationInformationKey *key)
Get/Set an entry storing another vtkInformation instance.
vtkInformation::Get
unsigned long Get(vtkInformationUnsignedLongKey *key)
Get/Set an unsigned-long-valued entry.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationRequestKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Append
void Append(vtkInformationKeyVectorKey *key, vtkInformationIntegerKey *value)
vtkInformation::Has
int Has(vtkInformationIntegerVectorKey *key)
Get/Set an integer-vector-valued entry.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationStringVectorKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Set
void Set(vtkInformationVariantVectorKey *key, const vtkVariant &value1, const vtkVariant &value2, const vtkVariant &value3)
Get/Set an variant-vector-valued entry.
vtkInformation::Has
int Has(vtkInformationDoubleVectorKey *key)
Get/Set an double-vector-valued entry.
vtkInformation::Get
int Get(vtkInformationIntegerVectorKey *key, int idx)
Get/Set an integer-vector-valued entry.
vtkInformation::Length
int Length(vtkInformationIntegerPointerKey *key)
Get/Set an integer-pointer-valued entry.
vtkInformation::Remove
void Remove(vtkInformationStringVectorKey *key)
Get/Set a string-vector-valued entry.
vtkInformation::Remove
void Remove(vtkInformationDataObjectKey *key)
Get/Set an entry storing a vtkDataObject instance.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationInformationVectorKey *key)
Upcast the given key instance.
vtkInformation::Get
double Get(vtkInformationDoubleVectorKey *key, int idx)
Get/Set an double-vector-valued entry.
vtkInformation::Remove
void Remove(vtkInformationKeyVectorKey *key, vtkInformationKey *value)
Get/Set an InformationKey-vector-valued entry.
vtkInformation::Set
void Set(vtkInformationStringVectorKey *key, const char *value, int idx=0)
Get/Set a string-vector-valued entry.
vtkInformation::Length
int Length(vtkInformationStringVectorKey *key)
Get/Set a string-vector-valued entry.
vtkInformation::Has
int Has(vtkInformationKeyVectorKey *key)
Get/Set an InformationKey-vector-valued entry.
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationIntegerKey *value)
vtkInformation::AppendUnique
void AppendUnique(vtkInformationKeyVectorKey *key, vtkInformationInformationKey *value)
vtkInformation::Get
vtkObjectBase * Get(vtkInformationObjectBaseKey *key)
Get/Set an entry storing a vtkObjectBase instance.
vtkInformation::Remove
void Remove(vtkInformationObjectBaseVectorKey *key, vtkObjectBase *objectToRemove)
Manipulate a ObjectBaseVector entry.
vtkInformation::New
static vtkInformation * New()
vtkInformation::Set
void Set(vtkInformationDataObjectKey *key, vtkDataObject VTK_WRAP_EXTERN *)
Get/Set an entry storing a vtkDataObject instance.
vtkInformation::Get
const vtkVariant & Get(vtkInformationVariantKey *key)
Get/Set an variant-valued entry.
vtkInformation::Has
int Has(vtkInformationObjectBaseVectorKey *key)
Manipulate a ObjectBaseVector entry.
vtkInformation::Has
int Has(vtkInformationStringKey *key)
Get/Set a string-valued entry.
vtkInformation::Append
void Append(vtkInformationVariantVectorKey *key, const vtkVariant &value)
Get/Set an variant-vector-valued entry.
vtkInformation::CopyEntry
void CopyEntry(vtkInformation *from, vtkInformationObjectBaseVectorKey *key, vtkTypeBool deep=0)
Copy the key/value pair associated with the given key in the given information object.
vtkInformation::Copy
void Copy(vtkInformation *from, vtkTypeBool deep=0)
Copy all information entries from the given vtkInformation instance.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationStringVectorKey *key)
Upcast the given key instance.
vtkInformation::Set
void Set(vtkInformationIntegerKey *key, int value)
Get/Set an integer-valued entry.
vtkInformation::Remove
void Remove(vtkInformationRequestKey *key)
Get/Set a request-valued entry.
vtkInformation::Remove
void Remove(vtkInformationIntegerKey *key)
Get/Set an integer-valued entry.
vtkInformation::Length
int Length(vtkInformationObjectBaseVectorKey *key)
Manipulate a ObjectBaseVector entry.
vtkInformation::Remove
void Remove(vtkInformationIdTypeKey *key)
Get/Set a vtkIdType-valued entry.
vtkInformation::PrintKeys
void PrintKeys(ostream &os, vtkIndent indent)
vtkInformation::Set
void Set(vtkInformationStringKey *key, const std::string &)
Get/Set a string-valued entry.
vtkInformation::Has
int Has(vtkInformationKey *key)
Check whether the given key appears in this information object.
vtkInformation::GetKey
static vtkInformationKey * GetKey(vtkInformationKey *key)
Upcast the given key instance.
vtkInformation::Set
void Set(vtkInformationIdTypeKey *key, vtkIdType value)
Get/Set a vtkIdType-valued entry.
vtkInformation::Append
void Append(vtkInformation *from, vtkTypeBool deep=0)
Append all information entries from the given vtkInformation instance.
vtkObjectBase
abstract base class for most VTK objects
Definition: vtkObjectBase.h:72
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:61
vtkVariant
A type representing the union of many types.
Definition: vtkVariant.h:62
vtkX3D::key
@ key
Definition: vtkX3D.h:257
vtkX3D::length
@ length
Definition: vtkX3D.h:393
vtkX3D::value
@ value
Definition: vtkX3D.h:220
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkX3D::string
@ string
Definition: vtkX3D.h:490
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:64
vtkObject.h
vtkIdType
int vtkIdType
Definition: vtkType.h:315