VTK  9.0.3
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 
95 
101 
107  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
108 
115  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
116 
123 
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 
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 
208  void InsertValue(vtkIdType id, const char* val) VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
209 
215 
221 
226  vtkIdType InsertNextValue(const char* f) VTK_EXPECTS(f != nullptr);
227 
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 
314 
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:
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
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:35
StdString::value_type value_type
Definition: vtkStdString.h:38
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.
void Squeeze() override
Free any unnecessary memory.
void SetVariantValue(vtkIdType idx, vtkVariant value) override
Set a value in the array form a variant.
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.
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
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 data 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.
vtkIdType GetNumberOfValues()
~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:338
#define VTK_STRING
Definition: vtkType.h:58
void save(Archiver &ar, const vtkUnicodeString &str, const unsigned int vtkNotUsed(version))
#define VTK_EXPECTS(x)
#define VTK_NEWINSTANCE