VTK  9.3.0
vtkStringArray.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2004 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
21 #ifndef vtkStringArray_h
22 #define vtkStringArray_h
23 
24 #include "vtkAbstractArray.h"
25 #include "vtkCommonCoreModule.h" // For export macro
26 #include "vtkStdString.h" // needed for vtkStdString definition
27 
28 VTK_ABI_NAMESPACE_BEGIN
29 class vtkStringArrayLookup;
30 
31 class VTKCOMMONCORE_EXPORT vtkStringArray : public vtkAbstractArray
32 {
33 public:
35  {
37  VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
38  VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
39  VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
40  };
41 
42  static vtkStringArray* New();
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
47  //
48  //
49  // Functions required by vtkAbstractArray
50  //
51  //
52 
56  int GetDataType() const override { return VTK_STRING; }
57 
58  int IsNumeric() const override { return 0; }
59 
63  void Initialize() override;
64 
71  int GetDataTypeSize() const override;
72 
77  void Squeeze() override { this->ResizeAndExtend(this->MaxId + 1); }
78 
82  vtkTypeBool Resize(vtkIdType numTuples) override;
83 
91 
97 
103  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
104 
106  vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
107 
114  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
115 
122 
131  vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
132 
142  vtkAbstractArray* source2, double t) override;
143 
150  void GetTuples(vtkIdList* ptIds, vtkAbstractArray* output) override;
151 
159  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output) override;
160 
165  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
166 
170  const vtkStdString& GetValue(vtkIdType id) const
171  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
172 
177 
183  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
184  {
185  this->Array[id] = value;
186  this->DataChanged();
187  }
188 
189  void SetValue(vtkIdType id, const char* value)
190  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues()) VTK_EXPECTS(value != nullptr);
191 
196  void SetNumberOfTuples(vtkIdType number) override
197  {
198  this->SetNumberOfValues(this->NumberOfComponents * number);
199  }
200 
204  vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
205 
206  int GetNumberOfElementComponents() { return 0; }
207  int GetElementComponentSize() const override
208  {
209  return static_cast<int>(sizeof(vtkStdString::value_type));
210  }
211 
216  void InsertValue(vtkIdType id, const char* val) VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
217 
223 
229 
234  vtkIdType InsertNextValue(const char* f) VTK_EXPECTS(f != nullptr);
235 
242 
247  vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
248  void* GetVoidPointer(vtkIdType id) override { return this->GetPointer(id); }
249 
254  void DeepCopy(vtkAbstractArray* aa) override;
255 
268  void SetArray(
269  vtkStdString* array, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
270  void SetVoidArray(void* array, vtkIdType size, int save) override
271  {
272  this->SetArray(static_cast<vtkStdString*>(array), size, save);
273  }
274  void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override
275  {
276  this->SetArray(static_cast<vtkStdString*>(array), size, save, deleteMethod);
277  }
278 
285  void SetArrayFreeFunction(void (*callback)(void*)) override;
286 
298  unsigned long GetActualMemorySize() const override;
299 
304 
310  vtkIdType GetDataSize() const override;
311 
313 
317  void LookupValue(vtkVariant value, vtkIdList* ids) override;
319 
322 
324  void LookupValue(const char* value, vtkIdList* ids);
325 
334  void DataChanged() override;
335 
341  virtual void DataElementChanged(vtkIdType id);
342 
348  void ClearLookup() override;
349 
350 protected:
352  ~vtkStringArray() override;
353 
354  vtkStdString* Array; // pointer to data
355  vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
356 
357  void (*DeleteFunction)(void*);
358 
359 private:
360  vtkStringArray(const vtkStringArray&) = delete;
361  void operator=(const vtkStringArray&) = delete;
362 
363  vtkStringArrayLookup* Lookup;
364  void UpdateLookup();
365 };
366 
367 VTK_ABI_NAMESPACE_END
368 #endif
Abstract superclass for all arrays.
virtual bool SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
virtual void DataChanged()=0
Tell the array explicitly that the data has changed.
Abstract superclass to iterate over elements in an vtkAbstractArray.
list of point or cell ids
Definition: vtkIdList.h:23
a simple class to control print indentation
Definition: vtkIndent.h:29
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:29
StdString::value_type value_type
Definition: vtkStdString.h:32
a vtkAbstractArray subclass for strings
int GetDataType() const override
Get the data type.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdType InsertNextValue(const char *f)
void SetVoidArray(void *array, vtkIdType size, int save, int deleteMethod) override
vtkStdString * Array
vtkIdType InsertNextValue(vtkStdString f)
Insert data at the end of the array.
int GetElementComponentSize() const override
Return the size, in bytes, of the lowest-level element of an array.
vtkIdType GetNumberOfValues() const
Return the number of values in the array.
void Squeeze() override
Free any unnecessary memory.
void SetVariantValue(vtkIdType idx, vtkVariant value) override
Set a value in the array form a variant.
const vtkStdString & GetValue(vtkIdType id) const
Read-access of string at a particular index.
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,...
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...
vtkStdString * ResizeAndExtend(vtkIdType sz)
virtual void DataElementChanged(vtkIdType id)
Tell the array explicitly that a single data element has changed.
void LookupValue(const vtkStdString &value, vtkIdList *ids)
vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000) override
Allocate memory for this array.
vtkIdType LookupValue(vtkVariant value) override
Return the indices where a specific value appears.
void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) override
Given a list of indices, return an array of values.
static vtkStringArray * New()
void ClearLookup() override
Delete the associated fast lookup data structure on this array, if it exists.
static vtkStringArray * ExtendedNew()
vtkIdType GetDataSize() const override
Returns the size of the data in DataTypeSize units.
void LookupValue(const char *value, vtkIdList *ids)
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...
void LookupValue(vtkVariant value, vtkIdList *ids) override
Return the indices where a specific value appears.
void InsertValue(vtkIdType id, const char *val)
void SetArray(vtkStdString *array, vtkIdType size, int save, int deleteMethod=VTK_DATA_ARRAY_DELETE)
This method lets the user specify data to be held by the array.
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
int GetNumberOfElementComponents()
unsigned long GetActualMemorySize() const override
Return the memory in kibibytes (1024 bytes) consumed by this data array.
void InsertValue(vtkIdType id, vtkStdString f)
Insert data at a specified position in the array.
void DeepCopy(vtkAbstractArray *aa) override
Deep copy of another string array.
void Initialize() override
Release storage and reset array to initial state.
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 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...
vtkStdString & GetValue(vtkIdType id)
Get the string at a particular index.
vtkIdType LookupValue(const vtkStdString &value)
void InsertVariantValue(vtkIdType idx, vtkVariant value) override
Safely set a value in the array form a variant.
void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override
Get the values for the range of indices specified (i.e., p1->p2 inclusive).
vtkIdType LookupValue(const char *value)
void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at ith location in this array.
vtkTypeBool Resize(vtkIdType numTuples) override
Resize the array while conserving the data.
~vtkStringArray() override
void SetValue(vtkIdType id, const char *value)
vtkStdString * WritePointer(vtkIdType id, vtkIdType number)
Get the address of a particular data index.
vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at the end in this array.
void SetValue(vtkIdType id, vtkStdString value)
Set the data at a particular index.
void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Set the tuple at the ith location using the jth tuple in the source array.
void DataChanged() override
Tell the array explicitly that the data has changed.
int IsNumeric() const override
This method is here to make backward compatibility easier.
vtkStdString * GetPointer(vtkIdType id)
Get the address of a particular data index.
void SetVoidArray(void *array, vtkIdType size, int save) override
vtkArrayIterator * NewIterator() override
Returns a vtkArrayIteratorTemplate<vtkStdString>.
int GetDataTypeSize() const override
Return the size of the data type.
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,...
A type representing the union of many types.
Definition: vtkVariant.h:53
@ value
Definition: vtkX3D.h:220
@ size
Definition: vtkX3D.h:253
int vtkTypeBool
Definition: vtkABI.h:64
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition: vtkType.h:315
#define VTK_STRING
Definition: vtkType.h:48
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
#define VTK_EXPECTS(x)
#define VTK_NEWINSTANCE