VTK  9.3.0
vtkVariantArray.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
18#ifndef vtkVariantArray_h
19#define vtkVariantArray_h
20
21#include "vtkAbstractArray.h"
22#include "vtkCommonCoreModule.h" // For export macro
23#include "vtkVariant.h" // For variant type
24
26namespace boost
27{
28namespace serialization
29{
30class access;
31}
32}
33
34VTK_ABI_NAMESPACE_BEGIN
35class vtkVariantArrayLookup;
36
37class VTKCOMMONCORE_EXPORT vtkVariantArray : public vtkAbstractArray
38{
39
41 friend class boost::serialization::access;
42
43public:
45 {
48 VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
49 VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
50 };
51
55 void PrintSelf(ostream& os, vtkIndent indent) override;
56
57 //
58 // Functions required by vtkAbstractArray
59 //
60
65 vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
66
70 void Initialize() override;
71
76 int GetDataType() const override;
77
83 int GetDataTypeSize() const override;
84
92 int GetElementComponentSize() const override;
93
98 void SetNumberOfTuples(vtkIdType number) override;
99
107
113
119 void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
120
122 vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
123
130 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
131
138
143 void* GetVoidPointer(vtkIdType id) override;
144
150 void DeepCopy(vtkAbstractArray* da) override;
151
160 vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
161
171 vtkAbstractArray* source2, double t) override;
172
178 void Squeeze() override;
179
184 vtkTypeBool Resize(vtkIdType numTuples) override;
185
187
195 void SetVoidArray(void* arr, vtkIdType size, int save) override;
196 void SetVoidArray(void* arr, vtkIdType size, int save, int deleteM) override;
198
207 unsigned long GetActualMemorySize() const override;
208
212 int IsNumeric() const override;
213
219
220 //
221 // Additional functions
222 //
223
228
234 VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
235
241 void InsertValue(vtkIdType id, vtkVariant value) VTK_EXPECTS(0 <= id);
242
246 void SetVariantValue(vtkIdType idx, vtkVariant value) override;
247
251 void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
252
258
263
268 vtkVariant* arr, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
269
276 void SetArrayFreeFunction(void (*callback)(void*)) override;
277
281 vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
282
284
288 void LookupValue(vtkVariant value, vtkIdList* ids) override;
290
299 void DataChanged() override;
300
307
313 void ClearLookup() override;
314
320
321protected:
322 // Construct object with default tuple dimension (number of components) of 1.
324
325 // Pointer to data
326
328
329 // Function to resize data
331
332 void (*DeleteFunction)(void*);
333
334private:
335 vtkVariantArray(const vtkVariantArray&) = delete;
336 void operator=(const vtkVariantArray&) = delete;
337
338 vtkVariantArrayLookup* Lookup;
339 void UpdateLookup();
340};
341
342VTK_ABI_NAMESPACE_END
343#endif
Abstract superclass for all arrays.
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
Abstract superclass to iterate over elements in an vtkAbstractArray.
list of point or cell ids
Definition vtkIdList.h:23
a simple class to control print indentation
Definition vtkIndent.h:29
An array holding vtkVariants.
vtkVariant * Array
void SetVoidArray(void *arr, vtkIdType size, int save, int deleteM) override
This method lets the user specify data to be held by the array.
void SetVoidArray(void *arr, vtkIdType size, int save) override
This method lets the user specify data to be held by the array.
static vtkVariantArray * New()
vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000) override
Allocate memory for this array.
int GetDataType() const override
Return the underlying data type.
void SetArrayFreeFunction(void(*callback)(void *)) override
This method allows the user to specify a custom free function to be called when the array is dealloca...
~vtkVariantArray() override
This destructor is public to work around a bug in version 1.36.0 of the Boost.Serialization library.
void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in t...
static vtkVariantArray * ExtendedNew()
vtkTypeBool Resize(vtkIdType numTuples) override
Resize the array while conserving the data.
void InsertTuplesStartingAt(vtkIdType dstStart, vtkIdList *srcIds, vtkAbstractArray *source) override
Copy the tuples indexed in srcIds from the source array to the tuple locations starting at index dstS...
vtkIdType InsertNextValue(vtkVariant value)
Expand the array by one and set the value at that location.
void InsertVariantValue(vtkIdType idx, vtkVariant value) override
Safely insert a value into the array from a variant.
vtkArrayIterator * NewIterator() override
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
void ClearLookup() override
Delete the associated fast lookup data structure on this array, if it exists.
unsigned long GetActualMemorySize() const override
Return the memory in kibibytes (1024 bytes) consumed by this data array.
vtkIdType LookupValue(vtkVariant value) override
Return the indices where a specific value appears.
void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Set the tuple at the ith location using the jth tuple in the source array.
vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at the end in this array.
void SetVariantValue(vtkIdType idx, vtkVariant value) override
Insert a value into the array from a variant.
int GetDataTypeSize() const override
Return the size of the underlying data type.
void SetNumberOfTuples(vtkIdType number) override
Set the number of tuples (a component group) in the array.
void LookupValue(vtkVariant value, vtkIdList *ids) override
Return the indices where a specific value appears.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void DataElementChanged(vtkIdType id)
Tell the array explicitly that a single data element has changed.
void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights) override
Set the ith tuple in this array as the interpolated tuple value, given the ptIndices in the source ar...
void InterpolateTuple(vtkIdType i, vtkIdType id1, vtkAbstractArray *source1, vtkIdType id2, vtkAbstractArray *source2, double t) override
Insert the ith tuple in this array as interpolated from the two values, p1 and p2,...
void DeepCopy(vtkAbstractArray *da) override
Deep copy of data.
void DataChanged() override
Tell the array explicitly that the data has changed.
void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at ith location in this array.
void Squeeze() override
Free any unnecessary memory.
vtkVariant & GetValue(vtkIdType id) const
Get the data at a particular index.
int IsNumeric() const override
Since each item can be of a different type, we say that a variant array is not numeric.
vtkVariant * ResizeAndExtend(vtkIdType sz)
vtkVariant * GetPointer(vtkIdType id)
Return a pointer to the location in the internal array at the specified index.
void SetArray(vtkVariant *arr, vtkIdType size, int save, int deleteMethod=VTK_DATA_ARRAY_DELETE)
Set the internal array used by this object.
void SetValue(vtkIdType id, vtkVariant value)
Set the data at a particular index.
vtkIdType GetNumberOfValues() const
Return the number of values in the array.
void Initialize() override
Release storage and reset array to initial state.
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
void InsertValue(vtkIdType id, vtkVariant value)
If id < GetNumberOfValues(), overwrite the array at that index.
int GetElementComponentSize() const override
Return the size, in bytes, of the lowest-level element of an array.
void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source) override
Copy n consecutive tuples starting at srcStart from the source array to this array,...
A type representing the union of many types.
Definition vtkVariant.h:53
Forward declaration required for Boost serialization.
int vtkTypeBool
Definition vtkABI.h:64
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition vtkType.h:315
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
#define VTK_EXPECTS(x)
#define VTK_NEWINSTANCE