VTK  9.0.20210119
vtkUnicodeStringArray.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkUnicodeStringArray.h
5 
6 -------------------------------------------------------------------------
7  Copyright 2008 Sandia Corporation.
8  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9  the U.S. Government retains certain rights in this software.
10 -------------------------------------------------------------------------
11 
12  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
13  All rights reserved.
14  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
15 
16  This software is distributed WITHOUT ANY WARRANTY; without even
17  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
18  PURPOSE. See the above copyright notice for more information.
19 
20 =========================================================================*/
21 
32 #ifndef vtkUnicodeStringArray_h
33 #define vtkUnicodeStringArray_h
34 
35 #include "vtkAbstractArray.h"
36 #include "vtkCommonCoreModule.h" // For export macro
37 #include "vtkUnicodeString.h" // For value type
38 
39 class VTKCOMMONCORE_EXPORT vtkUnicodeStringArray : public vtkAbstractArray
40 {
41 public:
42  static vtkUnicodeStringArray* New();
43  static vtkUnicodeStringArray* ExtendedNew();
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
47  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
48  void Initialize() override;
49  int GetDataType() const override;
50  int GetDataTypeSize() const override;
51  int GetElementComponentSize() const override;
52  void SetNumberOfTuples(vtkIdType number) override;
53  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
55  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
56  void InsertTuples(
57  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
59  void* GetVoidPointer(vtkIdType id) override;
60  void DeepCopy(vtkAbstractArray* da) override;
61  void InterpolateTuple(
62  vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
64  vtkAbstractArray* source2, double t) override;
65  void Squeeze() override;
66  vtkTypeBool Resize(vtkIdType numTuples) override;
67  void SetVoidArray(void* array, vtkIdType size, int save) override;
68  void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override;
69  void SetArrayFreeFunction(void (*callback)(void*)) override;
70  unsigned long GetActualMemorySize() const override; // in bytes
71  int IsNumeric() const override;
73  vtkVariant GetVariantValue(vtkIdType idx) override;
75  void LookupValue(vtkVariant value, vtkIdList* ids) override;
76 
77  void SetVariantValue(vtkIdType idx, vtkVariant value) override;
78  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
79  void DataChanged() override;
80  void ClearLookup() override;
81 
82  vtkIdType InsertNextValue(const vtkUnicodeString&);
83  void InsertValue(vtkIdType idx, const vtkUnicodeString&); // Ranged checked
84  void SetValue(vtkIdType i, const vtkUnicodeString&); // Not ranged checked
85  vtkUnicodeString& GetValue(vtkIdType i);
86 
87  void InsertNextUTF8Value(const char*);
88  void SetUTF8Value(vtkIdType i, const char*);
89  const char* GetUTF8Value(vtkIdType i);
90 
91 protected:
93  ~vtkUnicodeStringArray() override;
94 
95 private:
97  void operator=(const vtkUnicodeStringArray&) = delete;
98 
99  class Implementation;
100  Implementation* Internal;
101 };
102 
103 #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::GetVariantValue
virtual vtkVariant GetVariantValue(vtkIdType valueIdx)
Retrieve value from the array as a variant.
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.
vtkUnicodeStringArray
Subclass of vtkAbstractArray that holds vtkUnicodeStrings.
Definition: vtkUnicodeStringArray.h:39
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.
vtkX3D::value
Definition: vtkX3D.h:226
vtkAbstractArray::GetElementComponentSize
virtual int GetElementComponentSize() const =0
Return the size, in bytes, of the lowest-level element of an array.
vtkIdType
int vtkIdType
Definition: vtkType.h:330
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:64
vtkUnicodeString.h
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::GetDataType
virtual int GetDataType() const =0
Return the underlying data type.
vtkAbstractArray::IsNumeric
virtual int IsNumeric() const =0
This method is here to make backward compatibility easier.
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.
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.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkUnicodeString
String class that stores Unicode text.
Definition: vtkUnicodeString.h:69
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:65
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:30
vtkX3D::size
Definition: vtkX3D.h:259
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:75
vtkAbstractArray::GetActualMemorySize
virtual unsigned long GetActualMemorySize() const =0
Return the memory in kibibytes (1024 bytes) consumed by this data array.
vtkAbstractArray::DeepCopy
virtual void DeepCopy(vtkAbstractArray *da)
Deep copy of data.
vtkArrayIterator
Abstract superclass to iterate over elements in an vtkAbstractArray.
Definition: vtkArrayIterator.h:49
vtkAbstractArray::GetDataTypeSize
virtual int GetDataTypeSize() const =0
Return the size of the underlying data type.
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:959
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:42
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.