VTK  9.2.6
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 "vtkAbstractArray.h"
38#include "vtkCommonCoreModule.h" // For export macro
39#include "vtkVariant.h" // For variant type
40
41class vtkVariantArrayLookup;
42
44namespace boost
45{
46namespace serialization
47{
48class access;
49}
50}
51
52class VTKCOMMONCORE_EXPORT vtkVariantArray : public vtkAbstractArray
53{
54
56 friend class boost::serialization::access;
57
58public:
60 {
63 VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
64 VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
65 };
66
70 void PrintSelf(ostream& os, vtkIndent indent) override;
71
72 //
73 // Functions required by vtkAbstractArray
74 //
75
80 vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
81
85 void Initialize() override;
86
91 int GetDataType() const override;
92
98 int GetDataTypeSize() const override;
99
107 int GetElementComponentSize() const override;
108
113 void SetNumberOfTuples(vtkIdType number) override;
114
122
128
134 void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
135
137 vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
138
145 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
146
153
158 void* GetVoidPointer(vtkIdType id) override;
159
165 void DeepCopy(vtkAbstractArray* da) override;
166
175 vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
176
186 vtkAbstractArray* source2, double t) override;
187
193 void Squeeze() override;
194
199 vtkTypeBool Resize(vtkIdType numTuples) override;
200
202
210 void SetVoidArray(void* arr, vtkIdType size, int save) override;
211 void SetVoidArray(void* arr, vtkIdType size, int save, int deleteM) override;
213
222 unsigned long GetActualMemorySize() const override;
223
227 int IsNumeric() const override;
228
234
235 //
236 // Additional functions
237 //
238
243
249 VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
250
256 void InsertValue(vtkIdType id, vtkVariant value) VTK_EXPECTS(0 <= id);
257
261 void SetVariantValue(vtkIdType idx, vtkVariant value) override;
262
266 void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
267
273
278
283 vtkVariant* arr, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
284
291 void SetArrayFreeFunction(void (*callback)(void*)) override;
292
296 vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
297
299
303 void LookupValue(vtkVariant value, vtkIdList* ids) override;
305
314 void DataChanged() override;
315
322
328 void ClearLookup() override;
329
335
336protected:
337 // Construct object with default tuple dimension (number of components) of 1.
339
340 // Pointer to data
341
343
344 // Function to resize data
346
347 void (*DeleteFunction)(void*);
348
349private:
350 vtkVariantArray(const vtkVariantArray&) = delete;
351 void operator=(const vtkVariantArray&) = delete;
352
353 vtkVariantArrayLookup* Lookup;
354 void UpdateLookup();
355};
356
357#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:34
a simple class to control print indentation
Definition vtkIndent.h:40
An array holding vtkVariants.
vtkVariant * Array
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...
static vtkVariantArray * ExtendedNew()
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.
vtkArrayIterator * NewIterator() override
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
void ClearLookup() override
Delete the associated fast lookup data structure on this array, if it exists.
unsigned long GetActualMemorySize() const override
Return the memory in kibibytes (1024 bytes) consumed by this data array.
vtkIdType LookupValue(vtkVariant value) override
Return the indices where a specific value appears.
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 & GetValue(vtkIdType id) const
Get the data at a particular index.
int IsNumeric() const override
Since each item can be of a different type, we say that a variant array is not numeric.
vtkVariant * ResizeAndExtend(vtkIdType sz)
vtkVariant * GetPointer(vtkIdType id)
Return a pointer to the location in the internal array at the specified index.
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 * GetVoidPointer(vtkIdType id) override
Return a void pointer.
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:70
Forward declaration required for Boost serialization.
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:332
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
#define VTK_EXPECTS(x)
#define VTK_NEWINSTANCE