VTK  9.3.1
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 
26 namespace boost
27 {
28 namespace serialization
29 {
30 class access;
31 }
32 }
33 
34 VTK_ABI_NAMESPACE_BEGIN
35 class vtkVariantArrayLookup;
36 
37 class VTKCOMMONCORE_EXPORT vtkVariantArray : public vtkAbstractArray
38 {
39 
41  friend class boost::serialization::access;
42 
43 public:
45  {
47  VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
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 
52  static vtkVariantArray* New();
53  static vtkVariantArray* ExtendedNew();
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 
106  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
107 
112  void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
113 
119  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
120 
122  vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
123 
129  void InsertTuples(
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 
159  void InterpolateTuple(
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 
227  vtkVariant& GetValue(vtkIdType id) const;
228 
233  void SetValue(vtkIdType id, vtkVariant value)
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 
257  vtkIdType InsertNextValue(vtkVariant value);
258 
262  vtkVariant* GetPointer(vtkIdType id);
263 
267  void SetArray(
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 
306  virtual void DataElementChanged(vtkIdType id);
307 
313  void ClearLookup() override;
314 
319  ~vtkVariantArray() override;
320 
321 protected:
322  // Construct object with default tuple dimension (number of components) of 1.
323  vtkVariantArray();
324 
325  // Pointer to data
326 
328 
329  // Function to resize data
330  vtkVariant* ResizeAndExtend(vtkIdType sz);
331 
332  void (*DeleteFunction)(void*);
333 
334 private:
335  vtkVariantArray(const vtkVariantArray&) = delete;
336  void operator=(const vtkVariantArray&) = delete;
337 
338  vtkVariantArrayLookup* Lookup;
339  void UpdateLookup();
340 };
341 
342 VTK_ABI_NAMESPACE_END
343 #endif
virtual void InsertTuplesStartingAt(vtkIdType dstStart, vtkIdList *srcIds, vtkAbstractArray *source)=0
Copy the tuples indexed in srcIds from the source array to the tuple locations starting at index dstS...
Forward declaration required for Boost serialization.
virtual void DataChanged()=0
Tell the array explicitly that the data has changed.
virtual void DeepCopy(vtkAbstractArray *da)
Deep copy of data.
virtual void * GetVoidPointer(vtkIdType valueIdx)=0
Return a void pointer.
An array holding vtkVariants.
Abstract superclass for all arrays.
virtual vtkIdType LookupValue(vtkVariant value)=0
Return the value indices where a specific value appears.
virtual int IsNumeric() const =0
This method is here to make backward compatibility easier.
virtual int GetElementComponentSize() const =0
Return the size, in bytes, of the lowest-level element of an array.
virtual int GetDataType() const =0
Return the underlying data type.
int vtkIdType
Definition: vtkType.h:315
virtual void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights)=0
Set the tuple at dstTupleIdx in this array to the interpolated tuple value, given the ptIndices in th...
virtual void SetVoidArray(void *vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save))=0
This method lets the user specify data to be held by the array.
virtual void Initialize()=0
Release storage and reset array to initial state.
A type representing the union of many types.
Definition: vtkVariant.h:52
int vtkTypeBool
Definition: vtkABI.h:64
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
virtual int GetDataTypeSize() const =0
Return the size of the underlying data type.
virtual unsigned long GetActualMemorySize() const =0
Return the memory in kibibytes (1024 bytes) consumed by this data array.
virtual void ClearLookup()=0
Delete the associated fast lookup data structure on this array, if it exists.
a simple class to control print indentation
Definition: vtkIndent.h:28
vtkVariant * Array
list of point or cell ids
Definition: vtkIdList.h:22
virtual vtkArrayIterator * NewIterator()=0
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Insert a value into the array from a variant.
Abstract superclass to iterate over elements in an vtkAbstractArray.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
#define VTK_NEWINSTANCE
virtual void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
virtual vtkTypeBool Allocate(vtkIdType numValues, vtkIdType ext=1000)=0
Allocate memory for this array.
virtual vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple from srcTupleIdx in the source array at the end of this array.
virtual vtkTypeBool Resize(vtkIdType numTuples)=0
Resize the array to the requested number of tuples and preserve data.
virtual void SetArrayFreeFunction(void(*callback)(void *))=0
This method allows the user to specify a custom free function to be called when the array is dealloca...
virtual void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array...
virtual void SetNumberOfTuples(vtkIdType numTuples)=0
Set the number of tuples (a component group) in the array.
virtual void Squeeze()=0
Free any unnecessary memory.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
vtkIdType GetNumberOfValues() const
Return the number of values in the array.
#define VTK_EXPECTS(x)
virtual void SetVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Set a value in the array from a variant.
virtual void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source)=0
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in t...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.