VTK  9.0.20210615
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 -------------------------------------------------------------------------*/
31 #ifndef vtkVariantArray_h
32 #define vtkVariantArray_h
33 
34 #include "vtkAbstractArray.h"
35 #include "vtkCommonCoreModule.h" // For export macro
36 #include "vtkVariant.h" // For variant type
37 
38 class vtkVariantArrayLookup;
39 
41 namespace boost
42 {
43 namespace serialization
44 {
45 class access;
46 }
47 }
48 
49 class VTKCOMMONCORE_EXPORT vtkVariantArray : public vtkAbstractArray
50 {
51 
53  friend class boost::serialization::access;
54 
55 public:
57  {
59  VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
60  VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
61  VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
62  };
63 
64  static vtkVariantArray* New();
67  void PrintSelf(ostream& os, vtkIndent indent) override;
68 
69  //
70  // Functions required by vtkAbstractArray
71  //
72 
77  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
78 
82  void Initialize() override;
83 
88  int GetDataType() const override;
89 
95  int GetDataTypeSize() const override;
96 
104  int GetElementComponentSize() const override;
105 
110  void SetNumberOfTuples(vtkIdType number) override;
111 
119 
125 
131  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
132 
139  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
140 
147 
152  void* GetVoidPointer(vtkIdType id) override;
153 
159  void DeepCopy(vtkAbstractArray* da) override;
160 
169  vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
170 
180  vtkAbstractArray* source2, double t) override;
181 
187  void Squeeze() override;
188 
193  vtkTypeBool Resize(vtkIdType numTuples) override;
194 
196 
204  void SetVoidArray(void* arr, vtkIdType size, int save) override;
205  void SetVoidArray(void* arr, vtkIdType size, int save, int deleteM) override;
207 
216  unsigned long GetActualMemorySize() const override;
217 
221  int IsNumeric() const override;
222 
228 
229  //
230  // Additional functions
231  //
232 
237 
243  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
244 
251 
256 
261 
267 
272 
276  void SetArray(
277  vtkVariant* arr, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
278 
285  void SetArrayFreeFunction(void (*callback)(void*)) override;
286 
290  vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
291 
293 
297  void LookupValue(vtkVariant value, vtkIdList* ids) override;
299 
308  void DataChanged() override;
309 
315  virtual void DataElementChanged(vtkIdType id);
316 
322  void ClearLookup() override;
323 
328  ~vtkVariantArray() override;
329 
330 protected:
331  // Construct object with default tuple dimension (number of components) of 1.
333 
334  // Pointer to data
335 
337 
338  // Function to resize data
340 
341  void (*DeleteFunction)(void*);
342 
343 private:
344  vtkVariantArray(const vtkVariantArray&) = delete;
345  void operator=(const vtkVariantArray&) = delete;
346 
347  vtkVariantArrayLookup* Lookup;
348  void UpdateLookup();
349 };
350 
351 #endif
vtkAbstractArray::DeleteMethod
DeleteMethod
Definition: vtkAbstractArray.h:322
vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE
@ VTK_DATA_ARRAY_ALIGNED_FREE
Definition: vtkAbstractArray.h:325
vtkVariant.h
vtkVariantArray::GetPointer
vtkVariant * GetPointer(vtkIdType id)
Return a pointer to the location in the internal array at the specified index.
vtkVariantArray::DeepCopy
void DeepCopy(vtkAbstractArray *da) override
Deep copy of data.
VTK_EXPECTS
#define VTK_EXPECTS(x)
Definition: vtkWrappingHints.h:47
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkAbstractArray::VTK_DATA_ARRAY_DELETE
@ VTK_DATA_ARRAY_DELETE
Definition: vtkAbstractArray.h:324
vtkIdType
int vtkIdType
Definition: vtkType.h:332
vtkVariantArray::GetElementComponentSize
int GetElementComponentSize() const override
Return the size, in bytes, of the lowest-level element of an array.
vtkVariantArray::GetVoidPointer
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
vtkVariantArray::GetValue
vtkVariant & GetValue(vtkIdType id) const
Get the data at a particular index.
vtkVariantArray::Initialize
void Initialize() override
Release storage and reset array to initial state.
vtkVariantArray::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAbstractArray::VTK_DATA_ARRAY_FREE
@ VTK_DATA_ARRAY_FREE
Definition: vtkAbstractArray.h:323
vtkVariantArray::GetDataType
int GetDataType() const override
Return the underlying data type.
vtkVariantArray::DataChanged
void DataChanged() override
Tell the array explicitly that the data has changed.
vtkVariantArray::InsertNextTuple
vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at the end in this array.
boost
Forward declaration required for Boost serialization.
Definition: vtkVariantArray.h:42
vtkVariantArray
An array holding vtkVariants.
Definition: vtkVariantArray.h:50
vtkVariantArray::ResizeAndExtend
vtkVariant * ResizeAndExtend(vtkIdType sz)
vtkVariantArray::InterpolateTuple
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,...
vtkVariantArray::GetDataTypeSize
int GetDataTypeSize() const override
Return the size of the underlying data type.
vtkAbstractArray.h
vtkVariantArray::SetVariantValue
void SetVariantValue(vtkIdType idx, vtkVariant value) override
Insert a value into the array from a variant.
vtkVariantArray::SetNumberOfTuples
void SetNumberOfTuples(vtkIdType number) override
Set the number of tuples (a component group) in the array.
vtkVariantArray::Allocate
vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000) override
Allocate memory for this array.
vtkVariantArray::LookupValue
vtkIdType LookupValue(vtkVariant value) override
Return the indices where a specific value appears.
vtkVariantArray::~vtkVariantArray
~vtkVariantArray() override
This destructor is public to work around a bug in version 1.36.0 of the Boost.Serialization library.
vtkVariantArray::InsertTuples
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,...
vtkAbstractArray::GetNumberOfValues
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
Definition: vtkAbstractArray.h:180
vtkVariantArray::ExtendedNew
static vtkVariantArray * ExtendedNew()
vtkVariantArray::InsertTuples
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...
vtkVariantArray::SetVoidArray
void SetVoidArray(void *arr, vtkIdType size, int save) override
This method lets the user specify data to be held by the array.
vtkVariantArray::InsertValue
void InsertValue(vtkIdType id, vtkVariant value)
If id < GetNumberOfValues(), overwrite the array at that index.
vtkVariantArray::InterpolateTuple
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...
vtkVariantArray::Squeeze
void Squeeze() override
Free any unnecessary memory.
vtkVariantArray::SetArrayFreeFunction
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::SetValue
void SetValue(vtkIdType id, vtkVariant value)
Set the data at a particular index.
vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
@ VTK_DATA_ARRAY_USER_DEFINED
Definition: vtkAbstractArray.h:326
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
save
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
Definition: vtkVariantBoostSerialization.h:64
vtkVariantArray::SetArray
void SetArray(vtkVariant *arr, vtkIdType size, int save, int deleteMethod=VTK_DATA_ARRAY_DELETE)
Set the internal array used by this object.
vtkVariantArray::InsertTuple
void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at ith location in this array.
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:66
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:31
vtkX3D::size
@ size
Definition: vtkX3D.h:259
vtkVariantArray::Resize
vtkTypeBool Resize(vtkIdType numTuples) override
Resize the array while conserving the data.
vtkVariantArray::LookupValue
void LookupValue(vtkVariant value, vtkIdList *ids) override
Return the indices where a specific value appears.
vtkVariantArray::New
static vtkVariantArray * New()
vtkVariantArray::InsertNextValue
vtkIdType InsertNextValue(vtkVariant value)
Expand the array by one and set the value at that location.
vtkVariantArray::vtkVariantArray
vtkVariantArray()
vtkVariantArray::InsertVariantValue
void InsertVariantValue(vtkIdType idx, vtkVariant value) override
Safely insert a value into the array from a variant.
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:76
vtkVariantArray::IsNumeric
int IsNumeric() const override
Since each item can be of a different type, we say that a variant array is not numeric.
vtkVariantArray::GetNumberOfValues
vtkIdType GetNumberOfValues() const
Return the number of values in the array.
Definition: vtkVariantArray.h:290
vtkVariantArray::Array
vtkVariant * Array
Definition: vtkVariantArray.h:336
vtkVariantArray::DataElementChanged
virtual void DataElementChanged(vtkIdType id)
Tell the array explicitly that a single data element has changed.
vtkVariantArray::SetTuple
void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Set the tuple at the ith location using the jth tuple in the source array.
vtkArrayIterator
Abstract superclass to iterate over elements in an vtkAbstractArray.
Definition: vtkArrayIterator.h:50
vtkVariantArray::NewIterator
vtkArrayIterator * NewIterator() override
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
vtkVariantArray::ClearLookup
void ClearLookup() override
Delete the associated fast lookup data structure on this array, if it exists.
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:959
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition: vtkWrappingHints.h:44
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkVariantArray::GetActualMemorySize
unsigned long GetActualMemorySize() const override
Return the memory in kibibytes (1024 bytes) consumed by this data array.
vtkVariantArray::SetVoidArray
void SetVoidArray(void *arr, vtkIdType size, int save, int deleteM) override
This method lets the user specify data to be held by the array.