VTK  9.2.20230205
vtkVariantArray.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkVariantArray.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
103 #ifndef vtkVariantArray_h
104 #define vtkVariantArray_h
105 
106 #include "vtkAbstractArray.h"
107 #include "vtkCommonCoreModule.h" // For export macro
108 #include "vtkVariant.h" // For variant type
109 
111 namespace boost
112 {
113 namespace serialization
114 {
115 class access;
116 }
117 }
118 
119 VTK_ABI_NAMESPACE_BEGIN
120 class vtkVariantArrayLookup;
121 
122 class VTKCOMMONCORE_EXPORT vtkVariantArray : public vtkAbstractArray
123 {
124 
126  friend class boost::serialization::access;
127 
128 public:
130  {
133  VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
134  VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
135  };
136 
137  static vtkVariantArray* New();
140  void PrintSelf(ostream& os, vtkIndent indent) override;
141 
142  //
143  // Functions required by vtkAbstractArray
144  //
145 
150  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
151 
155  void Initialize() override;
156 
161  int GetDataType() const override;
162 
168  int GetDataTypeSize() const override;
169 
177  int GetElementComponentSize() const override;
178 
183  void SetNumberOfTuples(vtkIdType number) override;
184 
192 
198 
204  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
205 
207  vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
208 
215  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
216 
223 
228  void* GetVoidPointer(vtkIdType id) override;
229 
235  void DeepCopy(vtkAbstractArray* da) override;
236 
245  vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
246 
256  vtkAbstractArray* source2, double t) override;
257 
263  void Squeeze() override;
264 
269  vtkTypeBool Resize(vtkIdType numTuples) override;
270 
272 
280  void SetVoidArray(void* arr, vtkIdType size, int save) override;
281  void SetVoidArray(void* arr, vtkIdType size, int save, int deleteM) override;
283 
292  unsigned long GetActualMemorySize() const override;
293 
297  int IsNumeric() const override;
298 
304 
305  //
306  // Additional functions
307  //
308 
313 
319  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
320 
327 
332 
337 
343 
348 
352  void SetArray(
353  vtkVariant* arr, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
354 
361  void SetArrayFreeFunction(void (*callback)(void*)) override;
362 
366  vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
367 
369 
373  void LookupValue(vtkVariant value, vtkIdList* ids) override;
375 
384  void DataChanged() override;
385 
391  virtual void DataElementChanged(vtkIdType id);
392 
398  void ClearLookup() override;
399 
404  ~vtkVariantArray() override;
405 
406 protected:
407  // Construct object with default tuple dimension (number of components) of 1.
409 
410  // Pointer to data
411 
413 
414  // Function to resize data
416 
417  void (*DeleteFunction)(void*);
418 
419 private:
420  vtkVariantArray(const vtkVariantArray&) = delete;
421  void operator=(const vtkVariantArray&) = delete;
422 
423  vtkVariantArrayLookup* Lookup;
424  void UpdateLookup();
425 };
426 
427 VTK_ABI_NAMESPACE_END
428 #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:144
a simple class to control print indentation
Definition: vtkIndent.h:120
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 atomic type representing the union of many types.
Definition: vtkVariant.h:150
Forward declaration required for Boost serialization.
@ value
Definition: vtkX3D.h:232
@ size
Definition: vtkX3D.h:265
int vtkTypeBool
Definition: vtkABI.h:71
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition: vtkType.h:327
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
#define VTK_EXPECTS(x)
#define VTK_NEWINSTANCE