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:
53  static vtkVariantArray* New();
55  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
57  //
58  // Functions required by vtkAbstractArray
59  //
60 
65  int Allocate(vtkIdType sz, vtkIdType ext=1000) override;
66 
70  void Initialize() override;
71 
76  int GetDataType() override;
77 
83  int GetDataTypeSize() override;
84 
92  int GetElementComponentSize() override;
93 
98  void SetNumberOfTuples(vtkIdType number) override;
99 
106  void SetTuple(vtkIdType i, vtkIdType j,
107  vtkAbstractArray* source) override;
108 
113  void InsertTuple(vtkIdType i, vtkIdType j,
114  vtkAbstractArray* source) override;
115 
121  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
122  vtkAbstractArray *source) override;
123 
129  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
130  vtkAbstractArray* source) override;
131 
138 
143  void *GetVoidPointer(vtkIdType id) override;
144 
150  void DeepCopy(vtkAbstractArray *da) override;
151 
159  void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices,
160  vtkAbstractArray* source, double* weights) override;
161 
171  vtkIdType id1, vtkAbstractArray* source1,
172  vtkIdType id2, vtkAbstractArray* source2, double t) override;
173 
179  void Squeeze() override;
180 
185  int Resize(vtkIdType numTuples) override;
186 
188 
196  void SetVoidArray(void *arr, vtkIdType size, int save) override;
197  void SetVoidArray(void *arr, vtkIdType size, int save,
198  int deleteM) override;
200 
209  unsigned long GetActualMemorySize() override;
210 
214  int IsNumeric() override;
215 
221 
222  //
223  // Additional functions
224  //
225 
229  vtkVariant & GetValue(vtkIdType id) const;
230 
235  void SetValue(vtkIdType id, vtkVariant value)
236  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
237 
243  void InsertValue(vtkIdType id, vtkVariant value)
244  VTK_EXPECTS(0 <= id);
245 
249  void SetVariantValue(vtkIdType idx, vtkVariant value) override;
250 
254  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
255 
260  vtkIdType InsertNextValue(vtkVariant value);
261 
265  vtkVariant* GetPointer(vtkIdType id);
266 
270  void SetArray(vtkVariant* arr, vtkIdType size, int save);
271 
277  void SetNumberOfValues(vtkIdType number) override;
278 
282  vtkIdType GetNumberOfValues() { return this->MaxId + 1; }
283 
285 
289  void LookupValue(vtkVariant value, vtkIdList* ids) override;
291 
300  void DataChanged() override;
301 
307  virtual void DataElementChanged(vtkIdType id);
308 
314  void ClearLookup() override;
315 
320  ~vtkVariantArray() override;
321 
322 protected:
323  // Construct object with default tuple dimension (number of components) of 1.
324  vtkVariantArray();
325 
326  // Pointer to data
327 
329 
330  // Function to resize data
331  vtkVariant* ResizeAndExtend(vtkIdType sz);
332 
334 
335 private:
336  vtkVariantArray(const vtkVariantArray&) = delete;
337  void operator=(const vtkVariantArray&) = delete;
338 
339  vtkVariantArrayLookup* Lookup;
340  void UpdateLookup();
341 };
342 
343 #endif
virtual int IsNumeric()=0
This method is here to make backward compatibility easier.
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
Forward declaration required for Boost serialization.
virtual void DataChanged()=0
Tell the array explicitly that the data has changed.
virtual void DeepCopy(vtkAbstractArray *da)
Deep copy of data.
virtual void * GetVoidPointer(vtkIdType valueIdx)=0
Return a void pointer.
An array holding vtkVariants.
Abstract superclass for all arrays.
virtual vtkIdType LookupValue(vtkVariant value)=0
Return the value indices where a specific value appears.
virtual int GetDataTypeSize()=0
Return the size of the underlying data type.
virtual void SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.
virtual int GetDataType()=0
Return the underlying data type.
int vtkIdType
Definition: vtkType.h:345
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...
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.
virtual void Initialize()=0
Release storage and reset array to initial state.
A atomic type representing the union of many types.
Definition: vtkVariant.h:70
vtkIdType GetNumberOfValues()
Return the number of values in the array.
virtual void ClearLookup()=0
Delete the associated fast lookup data structure on this array, if it exists.
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkVariant * Array
list of point or cell ids
Definition: vtkIdList.h:36
virtual int Resize(vtkIdType numTuples)=0
Resize the array to the requested number of tuples and preserve data.
virtual vtkArrayIterator * NewIterator()=0
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Insert a value into the array from a variant.
Abstract superclass to iterate over elements in an vtkAbstractArray.
#define VTK_NEWINSTANCE
virtual void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
virtual int Allocate(vtkIdType numValues, vtkIdType ext=1000)=0
Allocate memory for this array.
void save(Archiver &ar, const vtkUnicodeString &str, const unsigned int vtkNotUsed(version))
boost::graph_traits< vtkGraph *>::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
virtual vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple from srcTupleIdx in the source array at the end of this array.
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...
virtual unsigned long GetActualMemorySize()=0
Return the memory in kibibytes (1024 bytes) consumed by this data array.
virtual void SetNumberOfTuples(vtkIdType numTuples)=0
Set the number of tuples (a component group) in the array.
virtual void Squeeze()=0
Free any unnecessary memory.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual int GetElementComponentSize()=0
Return the size, in bytes, of the lowest-level element of an array.
#define VTK_EXPECTS(x)
virtual void SetVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Set a value in the array from a variant.
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...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.