VTK  9.1.0
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();
50  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
52  //
53  //
54  // Functions required by vtkAbstractArray
55  //
56  //
57 
61  int GetDataType() const override { return VTK_STRING; }
62 
63  int IsNumeric() const override { return 0; }
64 
68  void Initialize() override;
69 
76  int GetDataTypeSize() const override;
77 
82  void Squeeze() override { this->ResizeAndExtend(this->MaxId + 1); }
83 
87  vtkTypeBool Resize(vtkIdType numTuples) override;
88 
96 
102 
108  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
109 
116  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
117 
124 
133  vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
134 
144  vtkAbstractArray* source2, double t) override;
145 
152  void GetTuples(vtkIdList* ptIds, vtkAbstractArray* output) override;
153 
161  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output) override;
162 
167  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
168 
172  const vtkStdString& GetValue(vtkIdType id) const
173  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
174 
179 
185  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
186  {
187  this->Array[id] = value;
188  this->DataChanged();
189  }
190 
191  void SetValue(vtkIdType id, const char* value)
192  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues()) VTK_EXPECTS(value != nullptr);
193 
198  void SetNumberOfTuples(vtkIdType number) override
199  {
200  this->SetNumberOfValues(this->NumberOfComponents * number);
201  }
202 
206  vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
207 
208  int GetNumberOfElementComponents() { return 0; }
209  int GetElementComponentSize() const override
210  {
211  return static_cast<int>(sizeof(vtkStdString::value_type));
212  }
213 
218  void InsertValue(vtkIdType id, const char* val) VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
219 
225 
231 
236  vtkIdType InsertNextValue(const char* f) VTK_EXPECTS(f != nullptr);
237 
244 
249  vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
250  void* GetVoidPointer(vtkIdType id) override { return this->GetPointer(id); }
251 
256  void DeepCopy(vtkAbstractArray* aa) override;
257 
270  void SetArray(
271  vtkStdString* array, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
272  void SetVoidArray(void* array, vtkIdType size, int save) override
273  {
274  this->SetArray(static_cast<vtkStdString*>(array), size, save);
275  }
276  void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override
277  {
278  this->SetArray(static_cast<vtkStdString*>(array), size, save, deleteMethod);
279  }
280 
287  void SetArrayFreeFunction(void (*callback)(void*)) override;
288 
300  unsigned long GetActualMemorySize() const override;
301 
306 
312  vtkIdType GetDataSize() const override;
313 
315 
319  void LookupValue(vtkVariant value, vtkIdList* ids) override;
321 
324 
326  void LookupValue(const char* value, vtkIdList* ids);
327 
336  void DataChanged() override;
337 
343  virtual void DataElementChanged(vtkIdType id);
344 
350  void ClearLookup() override;
351 
352 protected:
354  ~vtkStringArray() override;
355 
356  vtkStdString* Array; // pointer to data
357  vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
358 
359  void (*DeleteFunction)(void*);
360 
361 private:
362  vtkStringArray(const vtkStringArray&) = delete;
363  void operator=(const vtkStringArray&) = delete;
364 
365  vtkStringArrayLookup* Lookup;
366  void UpdateLookup();
367 };
368 
369 #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:31
a simple class to control print indentation
Definition: vtkIndent.h:34
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:36
StdString::value_type value_type
Definition: vtkStdString.h:39
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...
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 atomic type representing the union of many types.
Definition: vtkVariant.h:66
@ value
Definition: vtkX3D.h:226
@ size
Definition: vtkX3D.h:259
int vtkTypeBool
Definition: vtkABI.h:69
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition: vtkType.h:332
#define VTK_STRING
Definition: vtkType.h:60
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
#define VTK_EXPECTS(x)
#define VTK_NEWINSTANCE