VTK  9.0.1
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 "vtkAbstractArray.h"
31 #include "vtkCommonCoreModule.h" // For export macro
32 #include "vtkStdString.h" // needed for vtkStdString definition
33 
34 class vtkStringArrayLookup;
35 
36 class VTKCOMMONCORE_EXPORT vtkStringArray : public vtkAbstractArray
37 {
38 public:
40  {
42  VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
43  VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
44  VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
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() const override { return VTK_STRING; }
61 
62  int IsNumeric() const override { return 0; }
63 
67  void Initialize() override;
68 
75  int GetDataTypeSize() const override;
76 
81  void Squeeze() override { this->ResizeAndExtend(this->MaxId + 1); }
82 
86  vtkTypeBool Resize(vtkIdType numTuples) override;
87 
94  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
95 
100  void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
101 
107  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
108 
114  void InsertTuples(
115  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
116 
123 
131  void InterpolateTuple(
132  vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
133 
143  vtkAbstractArray* source2, double t) override;
144 
151  void GetTuples(vtkIdList* ptIds, vtkAbstractArray* output) override;
152 
160  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output) override;
161 
166  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
167 
171  vtkStdString& GetValue(vtkIdType id) VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
172 
178  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
179  {
180  this->Array[id] = value;
181  this->DataChanged();
182  }
183 
184  void SetValue(vtkIdType id, const char* value)
185  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues()) VTK_EXPECTS(value != nullptr);
186 
191  void SetNumberOfTuples(vtkIdType number) override
192  {
193  this->SetNumberOfValues(this->NumberOfComponents * number);
194  }
195 
196  vtkIdType GetNumberOfValues() { return this->MaxId + 1; }
197 
198  int GetNumberOfElementComponents() { return 0; }
199  int GetElementComponentSize() const override
200  {
201  return static_cast<int>(sizeof(vtkStdString::value_type));
202  }
203 
207  void InsertValue(vtkIdType id, vtkStdString f) VTK_EXPECTS(0 <= id);
208  void InsertValue(vtkIdType id, const char* val) VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
209 
214  void SetVariantValue(vtkIdType idx, vtkVariant value) override;
215 
220  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
221 
225  vtkIdType InsertNextValue(vtkStdString f);
226  vtkIdType InsertNextValue(const char* f) VTK_EXPECTS(f != nullptr);
227 
233  vtkStdString* WritePointer(vtkIdType id, vtkIdType number);
234 
239  vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
240  void* GetVoidPointer(vtkIdType id) override { return this->GetPointer(id); }
241 
246  void DeepCopy(vtkAbstractArray* aa) override;
247 
260  void SetArray(
261  vtkStdString* array, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
262  void SetVoidArray(void* array, vtkIdType size, int save) override
263  {
264  this->SetArray(static_cast<vtkStdString*>(array), size, save);
265  }
266  void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override
267  {
268  this->SetArray(static_cast<vtkStdString*>(array), size, save, deleteMethod);
269  }
270 
277  void SetArrayFreeFunction(void (*callback)(void*)) override;
278 
290  unsigned long GetActualMemorySize() const override;
291 
296 
302  vtkIdType GetDataSize() const override;
303 
305 
309  void LookupValue(vtkVariant value, vtkIdList* ids) override;
311 
313  void LookupValue(const vtkStdString& value, vtkIdList* ids);
314 
315  vtkIdType LookupValue(const char* value);
316  void LookupValue(const char* value, vtkIdList* ids);
317 
326  void DataChanged() override;
327 
333  virtual void DataElementChanged(vtkIdType id);
334 
340  void ClearLookup() override;
341 
342 protected:
343  vtkStringArray();
344  ~vtkStringArray() override;
345 
346  vtkStdString* Array; // pointer to data
347  vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
348 
349  void (*DeleteFunction)(void*);
350 
351 private:
352  vtkStringArray(const vtkStringArray&) = delete;
353  void operator=(const vtkStringArray&) = delete;
354 
355  vtkStringArrayLookup* Lookup;
356  void UpdateLookup();
357 };
358 
359 #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
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:321
vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE
@ VTK_DATA_ARRAY_ALIGNED_FREE
Definition: vtkAbstractArray.h:325
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:44
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkAbstractArray::VTK_DATA_ARRAY_DELETE
@ VTK_DATA_ARRAY_DELETE
Definition: vtkAbstractArray.h:324
vtkIdType
int vtkIdType
Definition: vtkType.h:338
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:64
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
@ VTK_DATA_ARRAY_FREE
Definition: vtkAbstractArray.h:323
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::GetNumberOfValues
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
Definition: vtkAbstractArray.h:180
vtkStringArray::GetNumberOfValues
vtkIdType GetNumberOfValues()
Definition: vtkStringArray.h:196
VTK_STRING
#define VTK_STRING
Definition: vtkType.h:58
vtkStringArray::GetVoidPointer
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
Definition: vtkStringArray.h:240
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
@ VTK_DATA_ARRAY_USER_DEFINED
Definition: vtkAbstractArray.h:326
vtkAbstractArray::GetDataSize
virtual vtkIdType GetDataSize() const
Returns the size of the data in DataTypeSize units.
Definition: vtkAbstractArray.h:427
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:177
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:262
vtkX3D::size
@ size
Definition: vtkX3D.h:259
vtkStringArray::GetElementComponentSize
int GetElementComponentSize() const override
Return the size, in bytes, of the lowest-level element of an array.
Definition: vtkStringArray.h:199
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.
vtkStringArray::IsNumeric
int IsNumeric() const override
This method is here to make backward compatibility easier.
Definition: vtkStringArray.h:62
vtkAbstractArray::SetNumberOfValues
virtual bool SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.
vtkStringArray::GetDataType
int GetDataType() const override
Get the data type.
Definition: vtkStringArray.h:60
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:266
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
vtkStringArray::Squeeze
void Squeeze() override
Free any unnecessary memory.
Definition: vtkStringArray.h:81
vtkAbstractArray::GetTuples
virtual void GetTuples(vtkIdList *tupleIds, vtkAbstractArray *output)
Given a list of tuple ids, return an array of tuples.
vtkAbstractArray::GetDataTypeSize
virtual int GetDataTypeSize() const =0
Return the size of the underlying data type.
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:36
vtkStringArray::GetNumberOfElementComponents
int GetNumberOfElementComponents()
Definition: vtkStringArray.h:198
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
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
vtkStringArray::Array
vtkStdString * Array
Definition: vtkStringArray.h:346
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:239
vtkAbstractArray::Resize
virtual vtkTypeBool Resize(vtkIdType numTuples)=0
Resize the array to the requested number of tuples and preserve data.