VTK  9.2.20220705
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 
110 class vtkVariantArrayLookup;
111 
113 namespace boost
114 {
115 namespace serialization
116 {
117 class access;
118 }
119 }
120 
121 class VTKCOMMONCORE_EXPORT vtkVariantArray : public vtkAbstractArray
122 {
123 
125  friend class boost::serialization::access;
126 
127 public:
129  {
132  VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
133  VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
134  };
135 
136  static vtkVariantArray* New();
139  void PrintSelf(ostream& os, vtkIndent indent) override;
140 
141  //
142  // Functions required by vtkAbstractArray
143  //
144 
149  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
150 
154  void Initialize() override;
155 
160  int GetDataType() const override;
161 
167  int GetDataTypeSize() const override;
168 
176  int GetElementComponentSize() const override;
177 
182  void SetNumberOfTuples(vtkIdType number) override;
183 
191 
197 
203  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
204 
206  vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
207 
214  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
215 
222 
227  void* GetVoidPointer(vtkIdType id) override;
228 
234  void DeepCopy(vtkAbstractArray* da) override;
235 
244  vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
245 
255  vtkAbstractArray* source2, double t) override;
256 
262  void Squeeze() override;
263 
268  vtkTypeBool Resize(vtkIdType numTuples) override;
269 
271 
279  void SetVoidArray(void* arr, vtkIdType size, int save) override;
280  void SetVoidArray(void* arr, vtkIdType size, int save, int deleteM) override;
282 
291  unsigned long GetActualMemorySize() const override;
292 
296  int IsNumeric() const override;
297 
303 
304  //
305  // Additional functions
306  //
307 
312 
318  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
319 
326 
331 
336 
342 
347 
351  void SetArray(
352  vtkVariant* arr, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
353 
360  void SetArrayFreeFunction(void (*callback)(void*)) override;
361 
365  vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
366 
368 
372  void LookupValue(vtkVariant value, vtkIdList* ids) override;
374 
383  void DataChanged() override;
384 
390  virtual void DataElementChanged(vtkIdType id);
391 
397  void ClearLookup() override;
398 
403  ~vtkVariantArray() override;
404 
405 protected:
406  // Construct object with default tuple dimension (number of components) of 1.
408 
409  // Pointer to data
410 
412 
413  // Function to resize data
415 
416  void (*DeleteFunction)(void*);
417 
418 private:
419  vtkVariantArray(const vtkVariantArray&) = delete;
420  void operator=(const vtkVariantArray&) = delete;
421 
422  vtkVariantArrayLookup* Lookup;
423  void UpdateLookup();
424 };
425 
426 #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:143
a simple class to control print indentation
Definition: vtkIndent.h:119
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:159
Forward declaration required for Boost serialization.
@ value
Definition: vtkX3D.h:226
@ size
Definition: vtkX3D.h:259
int vtkTypeBool
Definition: vtkABI.h:69
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition: vtkType.h:325
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
#define VTK_EXPECTS(x)
#define VTK_NEWINSTANCE