VTK
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 -------------------------------------------------------------------------*/
34 #ifndef vtkVariantArray_h
35 #define vtkVariantArray_h
36 
37 #include "vtkCommonCoreModule.h" // For export macro
38 #include "vtkAbstractArray.h"
39 #include "vtkVariant.h" // For variant type
40 
41 class vtkVariantArrayLookup;
42 
44 namespace boost { namespace serialization { class access; } }
45 
46 class VTKCOMMONCORE_EXPORT vtkVariantArray : public vtkAbstractArray
47 {
48 
50  friend class boost::serialization::access;
51 
52 public:
54  {
57  VTK_DATA_ARRAY_ALIGNED_FREE=vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
59  };
60 
61  static vtkVariantArray* New();
63  void PrintSelf(ostream& os, vtkIndent indent) override;
64 
65  //
66  // Functions required by vtkAbstractArray
67  //
68 
73  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000) override;
74 
78  void Initialize() override;
79 
84  int GetDataType() override;
85 
91  int GetDataTypeSize() override;
92 
100  int GetElementComponentSize() override;
101 
106  void SetNumberOfTuples(vtkIdType number) override;
107 
114  void SetTuple(vtkIdType i, vtkIdType j,
115  vtkAbstractArray* source) override;
116 
121  void InsertTuple(vtkIdType i, vtkIdType j,
122  vtkAbstractArray* source) override;
123 
129  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
130  vtkAbstractArray *source) override;
131 
137  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
138  vtkAbstractArray* source) override;
139 
146 
151  void *GetVoidPointer(vtkIdType id) override;
152 
158  void DeepCopy(vtkAbstractArray *da) override;
159 
167  void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices,
168  vtkAbstractArray* source, double* weights) override;
169 
179  vtkIdType id1, vtkAbstractArray* source1,
180  vtkIdType id2, 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,
206  int deleteM) override;
208 
217  unsigned long GetActualMemorySize() override;
218 
222  int IsNumeric() override;
223 
229 
230  //
231  // Additional functions
232  //
233 
237  vtkVariant & GetValue(vtkIdType id) const;
238 
243  void SetValue(vtkIdType id, vtkVariant value)
244  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
245 
251  void InsertValue(vtkIdType id, vtkVariant value)
252  VTK_EXPECTS(0 <= id);
253 
257  void SetVariantValue(vtkIdType idx, vtkVariant value) override;
258 
262  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
263 
268  vtkIdType InsertNextValue(vtkVariant value);
269 
273  vtkVariant* GetPointer(vtkIdType id);
274 
278  void SetArray(vtkVariant* arr, vtkIdType size, int save, int deleteMethod=VTK_DATA_ARRAY_DELETE);
279 
286  void SetArrayFreeFunction(void (*callback)(void *)) override;
287 
293  void SetNumberOfValues(vtkIdType number) override;
294 
298  vtkIdType GetNumberOfValues() { return this->MaxId + 1; }
299 
301 
305  void LookupValue(vtkVariant value, vtkIdList* ids) override;
307 
316  void DataChanged() override;
317 
323  virtual void DataElementChanged(vtkIdType id);
324 
330  void ClearLookup() override;
331 
336  ~vtkVariantArray() override;
337 
338 protected:
339  // Construct object with default tuple dimension (number of components) of 1.
340  vtkVariantArray();
341 
342  // Pointer to data
343 
345 
346  // Function to resize data
347  vtkVariant* ResizeAndExtend(vtkIdType sz);
348 
349  void (*DeleteFunction)(void*);
350 
351 private:
352  vtkVariantArray(const vtkVariantArray&) = delete;
353  void operator=(const vtkVariantArray&) = delete;
354 
355  vtkVariantArrayLookup* Lookup;
356  void UpdateLookup();
357 };
358 
359 #endif
vtkAbstractArray::SetArrayFreeFunction
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...
vtkAbstractArray::Initialize
virtual void Initialize()=0
Release storage and reset array to initial state.
vtkAbstractArray::LookupValue
virtual vtkIdType LookupValue(vtkVariant value)=0
Return the value indices where a specific value appears.
vtkAbstractArray::Squeeze
virtual void Squeeze()=0
Free any unnecessary memory.
vtkAbstractArray::InterpolateTuple
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...
vtkAbstractArray::DeleteMethod
DeleteMethod
Definition: vtkAbstractArray.h:333
vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE
Definition: vtkAbstractArray.h:337
vtkVariant.h
vtkAbstractArray::SetVoidArray
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.
vtkAbstractArray::NewIterator
virtual vtkArrayIterator * NewIterator()=0
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
vtkAbstractArray::InsertTuple
virtual void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
VTK_EXPECTS
#define VTK_EXPECTS(x)
Definition: vtkWrappingHints.h:41
vtkX3D::value
Definition: vtkX3D.h:220
vtkAbstractArray::VTK_DATA_ARRAY_DELETE
Definition: vtkAbstractArray.h:336
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkAbstractArray::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAbstractArray::InsertNextTuple
virtual vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple from srcTupleIdx in the source array at the end of this array.
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkAbstractArray::SetNumberOfTuples
virtual void SetNumberOfTuples(vtkIdType numTuples)=0
Set the number of tuples (a component group) in the array.
save
void save(Archiver &ar, const vtkUnicodeString &str, const unsigned int vtkNotUsed(version))
Definition: vtkVariantBoostSerialization.h:65
vtkAbstractArray::InsertTuples
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...
vtkAbstractArray::VTK_DATA_ARRAY_FREE
Definition: vtkAbstractArray.h:335
boost
Forward declaration required for Boost serialization.
Definition: vtkVariantArray.h:44
vtkVariantArray
An array holding vtkVariants.
Definition: vtkVariantArray.h:46
vtkVariantArray::GetNumberOfValues
vtkIdType GetNumberOfValues()
Return the number of values in the array.
Definition: vtkVariantArray.h:298
vtkAbstractArray.h
vtkAbstractArray::Allocate
virtual vtkTypeBool Allocate(vtkIdType numValues, vtkIdType ext=1000)=0
Allocate memory for this array.
vtkAbstractArray::InsertVariantValue
virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Insert a value into the array from a variant.
vtkAbstractArray::GetVoidPointer
virtual void * GetVoidPointer(vtkIdType valueIdx)=0
Return a void pointer.
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:825
vtkAbstractArray::GetNumberOfValues
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
Definition: vtkAbstractArray.h:183
vtkAbstractArray::GetElementComponentSize
virtual int GetElementComponentSize()=0
Return the size, in bytes, of the lowest-level element of an array.
vtkAbstractArray::GetActualMemorySize
virtual unsigned long GetActualMemorySize()=0
Return the memory in kibibytes (1024 bytes) consumed by this data array.
vtkAbstractArray::SetTuple
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.
vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
Definition: vtkAbstractArray.h:338
vtkAbstractArray::IsNumeric
virtual int IsNumeric()=0
This method is here to make backward compatibility easier.
vtkAbstractArray::GetDataTypeSize
virtual int GetDataTypeSize()=0
Return the size of the underlying data type.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkAbstractArray::GetDataType
virtual int GetDataType()=0
Return the underlying data type.
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:71
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:36
vtkX3D::size
Definition: vtkX3D.h:253
vtkAbstractArray::SetVariantValue
virtual void SetVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Set a value in the array from a variant.
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:78
vtkVariantArray::Array
vtkVariant * Array
Definition: vtkVariantArray.h:344
vtkAbstractArray::DeepCopy
virtual void DeepCopy(vtkAbstractArray *da)
Deep copy of data.
vtkArrayIterator
Abstract superclass to iterate over elements in an vtkAbstractArray.
Definition: vtkArrayIterator.h:52
vtkAbstractArray::ClearLookup
virtual void ClearLookup()=0
Delete the associated fast lookup data structure on this array, if it exists.
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition: vtkWrappingHints.h:39
vtkAbstractArray::DataChanged
virtual void DataChanged()=0
Tell the array explicitly that the data has changed.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkAbstractArray::Resize
virtual vtkTypeBool Resize(vtkIdType numTuples)=0
Resize the array to the requested number of tuples and preserve data.
vtkAbstractArray::SetNumberOfValues
virtual void SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.