VTK  9.3.20240328
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
87 #ifndef vtkVariantArray_h
88 #define vtkVariantArray_h
89 
90 #include "vtkAbstractArray.h"
91 #include "vtkCommonCoreModule.h" // For export macro
92 #include "vtkVariant.h" // For variant type
93 
95 namespace boost
96 {
97 namespace serialization
98 {
99 class access;
100 }
101 }
102 
103 VTK_ABI_NAMESPACE_BEGIN
104 class vtkVariantArrayLookup;
105 
106 class VTKCOMMONCORE_EXPORT vtkVariantArray : public vtkAbstractArray
107 {
108 
110  friend class boost::serialization::access;
111 
112 public:
114  {
117  VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
118  VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
119  };
120 
121  static vtkVariantArray* New();
124  void PrintSelf(ostream& os, vtkIndent indent) override;
125 
126  //
127  // Functions required by vtkAbstractArray
128  //
129 
134  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
135 
139  void Initialize() override;
140 
145  int GetDataType() const override;
146 
152  int GetDataTypeSize() const override;
153 
161  int GetElementComponentSize() const override;
162 
167  void SetNumberOfTuples(vtkIdType number) override;
168 
176 
182 
188  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
189 
191  vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
192 
199  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
200 
207 
212  void* GetVoidPointer(vtkIdType id) override;
213 
219  void DeepCopy(vtkAbstractArray* da) override;
220 
229  vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
230 
240  vtkAbstractArray* source2, double t) override;
241 
247  void Squeeze() override;
248 
253  vtkTypeBool Resize(vtkIdType numTuples) override;
254 
256 
264  void SetVoidArray(void* arr, vtkIdType size, int save) override;
265  void SetVoidArray(void* arr, vtkIdType size, int save, int deleteM) override;
267 
276  unsigned long GetActualMemorySize() const override;
277 
281  int IsNumeric() const override;
282 
288 
289  //
290  // Additional functions
291  //
292 
297 
303  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
304 
311 
316 
321 
327 
332 
336  void SetArray(
337  vtkVariant* arr, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
338 
345  void SetArrayFreeFunction(void (*callback)(void*)) override;
346 
350  vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
351 
353 
357  void LookupValue(vtkVariant value, vtkIdList* ids) override;
359 
368  void DataChanged() override;
369 
375  virtual void DataElementChanged(vtkIdType id);
376 
382  void ClearLookup() override;
383 
388  ~vtkVariantArray() override;
389 
390 protected:
391  // Construct object with default tuple dimension (number of components) of 1.
393 
394  // Pointer to data
395 
397 
398  // Function to resize data
400 
401  void (*DeleteFunction)(void*);
402 
403 private:
404  vtkVariantArray(const vtkVariantArray&) = delete;
405  void operator=(const vtkVariantArray&) = delete;
406 
407  vtkVariantArrayLookup* Lookup;
408  void UpdateLookup();
409 };
410 
411 VTK_ABI_NAMESPACE_END
412 #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:132
a simple class to control print indentation
Definition: vtkIndent.h:108
An array holding vtkVariants.
vtkVariant * Array
static vtkVariantArray * ExtendedNew()
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...
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.
void ClearLookup() override
Delete the associated fast lookup data structure on this array, if it exists.
vtkVariant * ResizeAndExtend(vtkIdType sz)
unsigned long GetActualMemorySize() const override
Return the memory in kibibytes (1024 bytes) consumed by this data array.
vtkArrayIterator * NewIterator() override
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
vtkIdType LookupValue(vtkVariant value) override
Return the indices where a specific value appears.
vtkVariant & GetValue(vtkIdType id) const
Get the data at a particular index.
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 * GetPointer(vtkIdType id)
Return a pointer to the location in the internal array at the specified index.
int IsNumeric() const override
Since each item can be of a different type, we say that a variant array is not numeric.
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
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 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:162
Forward declaration required for Boost serialization.
@ value
Definition: vtkX3D.h:220
@ size
Definition: vtkX3D.h:253
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