VTK
vtkStringArray.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkStringArray.h
5  Language: C++
6 
7  Copyright 2004 Sandia Corporation.
8  Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9  license for use of this work by or on behalf of the
10  U.S. Government. Redistribution and use in source and binary forms, with
11  or without modification, are permitted provided that this Notice and any
12  statement of authorship are reproduced on all copies.
13 
14 =========================================================================*/
15 
27 #ifndef vtkStringArray_h
28 #define vtkStringArray_h
29 
30 #include "vtkCommonCoreModule.h" // For export macro
31 #include "vtkAbstractArray.h"
32 #include "vtkStdString.h" // needed for vtkStdString definition
33 
34 class vtkStringArrayLookup;
35 
36 class VTKCOMMONCORE_EXPORT vtkStringArray : public vtkAbstractArray
37 {
38 public:
40  {
43  VTK_DATA_ARRAY_ALIGNED_FREE=vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
45  };
46 
47  static vtkStringArray* New();
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
51  //
52  //
53  // Functions required by vtkAbstractArray
54  //
55  //
56 
60  int GetDataType() override
61  { return VTK_STRING; }
62 
63  int IsNumeric() override { return 0; }
64 
68  void Initialize() override;
69 
76  int GetDataTypeSize() override;
77 
82  void Squeeze() override { this->ResizeAndExtend (this->MaxId+1); }
83 
87  int Resize(vtkIdType numTuples) override;
88 
95  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
96 
101  void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
102 
108  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
109  vtkAbstractArray *source) override;
110 
116  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
117  vtkAbstractArray* source) override;
118 
125 
133  void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices,
134  vtkAbstractArray* source, double* weights) override;
135 
145  vtkIdType id1, vtkAbstractArray* source1,
146  vtkIdType id2, vtkAbstractArray* source2, double t) override;
147 
154  void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) override;
155 
163  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override;
164 
169  int Allocate( vtkIdType sz, vtkIdType ext=1000 ) override;
170 
174  vtkStdString &GetValue(vtkIdType id)
175  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
176 
182  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
183  { this->Array[id] = value; this->DataChanged(); }
184 
185  void SetValue(vtkIdType id, const char *value)
186  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
187  VTK_EXPECTS(value != nullptr);
188 
193  void SetNumberOfTuples(vtkIdType number) override
194  { this->SetNumberOfValues(this->NumberOfComponents* number); }
195 
201  void SetNumberOfValues(vtkIdType number) override;
202 
203  vtkIdType GetNumberOfValues() { return this->MaxId + 1; }
204 
205  int GetNumberOfElementComponents() { return 0; }
206  int GetElementComponentSize() override { return static_cast<int>(sizeof(vtkStdString::value_type)); }
207 
211  void InsertValue(vtkIdType id, vtkStdString f)
212  VTK_EXPECTS(0 <= id);
213  void InsertValue(vtkIdType id, const char *val)
214  VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
215 
220  void SetVariantValue(vtkIdType idx, vtkVariant value) override;
221 
226  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
227 
231  vtkIdType InsertNextValue(vtkStdString f);
232  vtkIdType InsertNextValue(const char *f)
233  VTK_EXPECTS(f != nullptr);
234 
240  vtkStdString* WritePointer(vtkIdType id, vtkIdType number);
241 
246  vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
247  void* GetVoidPointer(vtkIdType id) override { return this->GetPointer(id); }
248 
253  void DeepCopy( vtkAbstractArray* aa ) override;
254 
267  void SetArray(vtkStdString* array, vtkIdType size, int save, int deleteMethod=VTK_DATA_ARRAY_DELETE);
268  void SetVoidArray(void* array, vtkIdType size, int save) override
269  { this->SetArray(static_cast<vtkStdString*>(array), size, save); }
270  void SetVoidArray(void* array, vtkIdType size, int save,
271  int deleteMethod) override
272  { this->SetArray(static_cast<vtkStdString*>(array), size, save, deleteMethod); }
273 
280  void SetArrayFreeFunction(void (*callback)(void *)) override;
281 
293  unsigned long GetActualMemorySize() override;
294 
299 
305  vtkIdType GetDataSize() override;
306 
308 
312  void LookupValue(vtkVariant value, vtkIdList* ids) override;
314 
316  void LookupValue(const vtkStdString& value, vtkIdList* ids);
317 
318  vtkIdType LookupValue(const char* value);
319  void LookupValue(const char* value, vtkIdList* ids);
320 
329  void DataChanged() override;
330 
336  virtual void DataElementChanged(vtkIdType id);
337 
343  void ClearLookup() override;
344 
345 protected:
346  vtkStringArray();
347  ~vtkStringArray() override;
348 
349  vtkStdString* Array; // pointer to data
350  vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
351 
352  void (*DeleteFunction)(void*);
353 
354 private:
355  vtkStringArray(const vtkStringArray&) = delete;
356  void operator=(const vtkStringArray&) = delete;
357 
358  vtkStringArrayLookup* Lookup;
359  void UpdateLookup();
360 
361 };
362 
363 #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.
vtkStdString.h
vtkStringArray::GetElementComponentSize
int GetElementComponentSize() override
Return the size, in bytes, of the lowest-level element of an array.
Definition: vtkStringArray.h:206
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:330
vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE
Definition: vtkAbstractArray.h:334
vtkAbstractArray::GetDataSize
virtual vtkIdType GetDataSize()
Returns the size of the data in DataTypeSize units.
Definition: vtkAbstractArray.h:434
vtkAbstractArray::Resize
virtual int Resize(vtkIdType numTuples)=0
Resize the array to the requested number of tuples and preserve data.
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:333
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.
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:332
vtkAbstractArray.h
vtkAbstractArray::InsertVariantValue
virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Insert a value into the array from a variant.
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:180
vtkStringArray::GetNumberOfValues
vtkIdType GetNumberOfValues()
Definition: vtkStringArray.h:203
vtkAbstractArray::GetActualMemorySize
virtual unsigned long GetActualMemorySize()=0
Return the memory in kibibytes (1024 bytes) consumed by this data array.
VTK_STRING
#define VTK_STRING
Definition: vtkType.h:64
vtkStringArray::IsNumeric
int IsNumeric() override
This method is here to make backward compatibility easier.
Definition: vtkStringArray.h:63
vtkStringArray::GetVoidPointer
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
Definition: vtkStringArray.h:247
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:335
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:33
vtkStringArray::SetValue
void SetValue(vtkIdType id, vtkStdString value)
Set the data at a particular index.
Definition: vtkStringArray.h:181
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
vtkStringArray::SetVoidArray
void SetVoidArray(void *array, vtkIdType size, int save) override
Definition: vtkStringArray.h:268
vtkX3D::size
Definition: vtkX3D.h:253
vtkStringArray::GetDataType
int GetDataType() override
Get the data type.
Definition: vtkStringArray.h:60
vtkStdString::value_type
StdString::value_type value_type
Definition: vtkStdString.h:38
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
vtkStringArray::SetVoidArray
void SetVoidArray(void *array, vtkIdType size, int save, int deleteMethod) override
Definition: vtkStringArray.h:270
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
vtkStringArray::Squeeze
void Squeeze() override
Free any unnecessary memory.
Definition: vtkStringArray.h:82
vtkAbstractArray::GetTuples
virtual void GetTuples(vtkIdList *tupleIds, vtkAbstractArray *output)
Given a list of tuple ids, return an array of tuples.
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:36
vtkStringArray::GetNumberOfElementComponents
int GetNumberOfElementComponents()
Definition: vtkStringArray.h:205
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
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
vtkAbstractArray::Allocate
virtual int Allocate(vtkIdType numValues, vtkIdType ext=1000)=0
Allocate memory for this array.
vtkStringArray::Array
vtkStdString * Array
Definition: vtkStringArray.h:349
vtkAbstractArray::DataChanged
virtual void DataChanged()=0
Tell the array explicitly that the data has changed.
vtkStringArray::GetPointer
vtkStdString * GetPointer(vtkIdType id)
Get the address of a particular data index.
Definition: vtkStringArray.h:246
vtkAbstractArray::SetNumberOfValues
virtual void SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.