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 
33 #ifndef vtkStringArray_h
34 #define vtkStringArray_h
35 
36 #include "vtkCommonCoreModule.h" // For export macro
37 #include "vtkAbstractArray.h"
38 #include "vtkStdString.h" // needed for vtkStdString definition
39 
40 class vtkStringArrayLookup;
41 
42 class VTKCOMMONCORE_EXPORT vtkStringArray : public vtkAbstractArray
43 {
44 public:
46  {
49  VTK_DATA_ARRAY_ALIGNED_FREE=vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
51  };
52 
53  static vtkStringArray* New();
55  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
57  //
58  //
59  // Functions required by vtkAbstractArray
60  //
61  //
62 
66  int GetDataType() override
67  { return VTK_STRING; }
68 
69  int IsNumeric() override { return 0; }
70 
74  void Initialize() override;
75 
82  int GetDataTypeSize() override;
83 
88  void Squeeze() override { this->ResizeAndExtend (this->MaxId+1); }
89 
93  vtkTypeBool Resize(vtkIdType numTuples) override;
94 
101  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
102 
107  void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
108 
114  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
115  vtkAbstractArray *source) override;
116 
122  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
123  vtkAbstractArray* source) override;
124 
131 
139  void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices,
140  vtkAbstractArray* source, double* weights) override;
141 
151  vtkIdType id1, vtkAbstractArray* source1,
152  vtkIdType id2, vtkAbstractArray* source2, double t) override;
153 
160  void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) override;
161 
169  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override;
170 
175  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000 ) override;
176 
180  vtkStdString &GetValue(vtkIdType id)
181  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
182 
188  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
189  { this->Array[id] = value; this->DataChanged(); }
190 
191  void SetValue(vtkIdType id, const char *value)
192  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
193  VTK_EXPECTS(value != nullptr);
194 
199  void SetNumberOfTuples(vtkIdType number) override
200  { this->SetNumberOfValues(this->NumberOfComponents* number); }
201 
207  void SetNumberOfValues(vtkIdType number) override;
208 
209  vtkIdType GetNumberOfValues() { return this->MaxId + 1; }
210 
211  int GetNumberOfElementComponents() { return 0; }
212  int GetElementComponentSize() override { return static_cast<int>(sizeof(vtkStdString::value_type)); }
213 
217  void InsertValue(vtkIdType id, vtkStdString f)
218  VTK_EXPECTS(0 <= id);
219  void InsertValue(vtkIdType id, const char *val)
220  VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
221 
226  void SetVariantValue(vtkIdType idx, vtkVariant value) override;
227 
232  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
233 
237  vtkIdType InsertNextValue(vtkStdString f);
238  vtkIdType InsertNextValue(const char *f)
239  VTK_EXPECTS(f != nullptr);
240 
246  vtkStdString* WritePointer(vtkIdType id, vtkIdType number);
247 
252  vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
253  void* GetVoidPointer(vtkIdType id) override { return this->GetPointer(id); }
254 
259  void DeepCopy( vtkAbstractArray* aa ) override;
260 
273  void SetArray(vtkStdString* array, vtkIdType size, int save, int deleteMethod=VTK_DATA_ARRAY_DELETE);
274  void SetVoidArray(void* array, vtkIdType size, int save) override
275  { this->SetArray(static_cast<vtkStdString*>(array), size, save); }
276  void SetVoidArray(void* array, vtkIdType size, int save,
277  int deleteMethod) override
278  { this->SetArray(static_cast<vtkStdString*>(array), size, save, deleteMethod); }
279 
286  void SetArrayFreeFunction(void (*callback)(void *)) override;
287 
299  unsigned long GetActualMemorySize() override;
300 
305 
311  vtkIdType GetDataSize() override;
312 
314 
318  void LookupValue(vtkVariant value, vtkIdList* ids) override;
320 
322  void LookupValue(const vtkStdString& value, vtkIdList* ids);
323 
324  vtkIdType LookupValue(const char* value);
325  void LookupValue(const char* value, vtkIdList* ids);
326 
335  void DataChanged() override;
336 
342  virtual void DataElementChanged(vtkIdType id);
343 
349  void ClearLookup() override;
350 
351 protected:
352  vtkStringArray();
353  ~vtkStringArray() override;
354 
355  vtkStdString* Array; // pointer to data
356  vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
357 
358  void (*DeleteFunction)(void*);
359 
360 private:
361  vtkStringArray(const vtkStringArray&) = delete;
362  void operator=(const vtkStringArray&) = delete;
363 
364  vtkStringArrayLookup* Lookup;
365  void UpdateLookup();
366 
367 };
368 
369 #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:212
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
vtkAbstractArray::GetDataSize
virtual vtkIdType GetDataSize()
Returns the size of the data in DataTypeSize units.
Definition: vtkAbstractArray.h:437
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.
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
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.
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
vtkStringArray::GetNumberOfValues
vtkIdType GetNumberOfValues()
Definition: vtkStringArray.h:209
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:69
vtkStringArray::GetVoidPointer
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
Definition: vtkStringArray.h:253
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::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
vtkStringArray::SetValue
void SetValue(vtkIdType id, vtkStdString value)
Set the data at a particular index.
Definition: vtkStringArray.h:187
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
vtkStringArray::SetVoidArray
void SetVoidArray(void *array, vtkIdType size, int save) override
Definition: vtkStringArray.h:274
vtkX3D::size
Definition: vtkX3D.h:253
vtkStringArray::GetDataType
int GetDataType() override
Get the data type.
Definition: vtkStringArray.h:66
vtkStdString::value_type
StdString::value_type value_type
Definition: vtkStdString.h:44
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
vtkStringArray::SetVoidArray
void SetVoidArray(void *array, vtkIdType size, int save, int deleteMethod) override
Definition: vtkStringArray.h:276
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
vtkStringArray::Squeeze
void Squeeze() override
Free any unnecessary memory.
Definition: vtkStringArray.h:88
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:42
vtkStringArray::GetNumberOfElementComponents
int GetNumberOfElementComponents()
Definition: vtkStringArray.h:211
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:40
vtkStringArray::Array
vtkStdString * Array
Definition: vtkStringArray.h:355
vtkAbstractArray::DataChanged
virtual void DataChanged()=0
Tell the array explicitly that the data has changed.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkStringArray::GetPointer
vtkStdString * GetPointer(vtkIdType id)
Get the address of a particular data index.
Definition: vtkStringArray.h:252
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.