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 
27 #ifndef vtkStringArray_h
28 #define vtkStringArray_h
29 
30 #include "vtkCommonCoreModule.h" // For export macro
31 #include "vtkAbstractArray.h"
32 #include "vtkStdString.h" // needed for vtkStdString definition
33 
34 class vtkStringArrayLookup;
35 
36 class VTKCOMMONCORE_EXPORT vtkStringArray : public vtkAbstractArray
37 {
38 public:
39  static vtkStringArray* New();
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
43  //
44  //
45  // Functions required by vtkAbstractArray
46  //
47  //
48 
52  int GetDataType() override
53  { return VTK_STRING; }
54 
55  int IsNumeric() override { return 0; }
56 
60  void Initialize() override;
61 
68  int GetDataTypeSize() override;
69 
74  void Squeeze() override { this->ResizeAndExtend (this->MaxId+1); }
75 
79  int Resize(vtkIdType numTuples) override;
80 
87  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
88 
94 
100  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
101  vtkAbstractArray *source) override;
102 
108  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
109  vtkAbstractArray* source) override;
110 
117 
125  void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices,
126  vtkAbstractArray* source, double* weights) override;
127 
137  vtkIdType id1, vtkAbstractArray* source1,
138  vtkIdType id2, vtkAbstractArray* source2, double t) override;
139 
146  void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) override;
147 
155  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override;
156 
161  int Allocate( vtkIdType sz, vtkIdType ext=1000 ) override;
162 
166  vtkStdString &GetValue(vtkIdType id)
167  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
168 
174  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
175  { this->Array[id] = value; this->DataChanged(); }
176 
177  void SetValue(vtkIdType id, const char *value)
178  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
179  VTK_EXPECTS(value != nullptr);
180 
185  void SetNumberOfTuples(vtkIdType number) override
186  { this->SetNumberOfValues(this->NumberOfComponents* number); }
187 
193  void SetNumberOfValues(vtkIdType number) override;
194 
195  vtkIdType GetNumberOfValues() { return this->MaxId + 1; }
196 
197  int GetNumberOfElementComponents() { return 0; }
198  int GetElementComponentSize() override { return static_cast<int>(sizeof(vtkStdString::value_type)); }
199 
203  void InsertValue(vtkIdType id, vtkStdString f)
204  VTK_EXPECTS(0 <= id);
205  void InsertValue(vtkIdType id, const char *val)
206  VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
207 
212  void SetVariantValue(vtkIdType idx, vtkVariant value) override;
213 
218  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
219 
223  vtkIdType InsertNextValue(vtkStdString f);
224  vtkIdType InsertNextValue(const char *f)
225  VTK_EXPECTS(f != nullptr);
226 
232  vtkStdString* WritePointer(vtkIdType id, vtkIdType number);
233 
238  vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
239  void* GetVoidPointer(vtkIdType id) override { return this->GetPointer(id); }
240 
245  void DeepCopy( vtkAbstractArray* aa ) override;
246 
257  void SetArray(vtkStdString* array, vtkIdType size, int save);
258  void SetVoidArray(void* array, vtkIdType size, int save) override
259  { this->SetArray(static_cast<vtkStdString*>(array), size, save); }
260  void SetVoidArray(void* array, vtkIdType size, int save,
261  int vtkNotUsed(deleteMethod)) override
262  { this->SetArray(static_cast<vtkStdString*>(array), size, save); }
263 
275  unsigned long GetActualMemorySize() override;
276 
281 
287  vtkIdType GetDataSize() override;
288 
290 
294  void LookupValue(vtkVariant value, vtkIdList* ids) override;
296 
298  void LookupValue(const vtkStdString& value, vtkIdList* ids);
299 
300  vtkIdType LookupValue(const char* value);
301  void LookupValue(const char* value, vtkIdList* ids);
302 
311  void DataChanged() override;
312 
318  virtual void DataElementChanged(vtkIdType id);
319 
325  void ClearLookup() override;
326 
327 protected:
328  vtkStringArray();
329  ~vtkStringArray() override;
330 
331  vtkStdString* Array; // pointer to data
332  vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
333 
335 
336 private:
337  vtkStringArray(const vtkStringArray&) = delete;
338  void operator=(const vtkStringArray&) = delete;
339 
340  vtkStringArrayLookup* Lookup;
341  void UpdateLookup();
342 
343 };
344 
345 #endif
void SetVoidArray(void *array, vtkIdType size, int save, int vtkNotUsed(deleteMethod)) override
This method lets the user specify data to be held by the array.
vtkIdType GetNumberOfValues()
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
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.
vtkStdString * GetPointer(vtkIdType id)
Get the address of a particular data index.
virtual void DeepCopy(vtkAbstractArray *da)
Deep copy of data.
virtual void GetTuples(vtkIdList *tupleIds, vtkAbstractArray *output)
Given a list of tuple ids, return an array of tuples.
Abstract superclass for all arrays.
virtual vtkIdType LookupValue(vtkVariant value)=0
Return the value indices where a specific value appears.
virtual int GetDataTypeSize()=0
Return the size of the underlying data type.
vtkStdString * Array
virtual void SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.
a vtkAbstractArray subclass for strings
int vtkIdType
Definition: vtkType.h:345
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...
int GetElementComponentSize() override
Return the size, in bytes, of the lowest-level element of an array.
virtual void Initialize()=0
Release storage and reset array to initial state.
A atomic type representing the union of many types.
Definition: vtkVariant.h:65
void SetValue(vtkIdType id, vtkStdString value)
Set the data at a particular index.
#define VTK_STRING
Definition: vtkType.h:64
virtual vtkIdType GetDataSize()
Returns the size of the data in DataTypeSize units.
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
virtual void ClearLookup()=0
Delete the associated fast lookup data structure on this array, if it exists.
a simple class to control print indentation
Definition: vtkIndent.h:33
list of point or cell ids
Definition: vtkIdList.h:30
virtual int Resize(vtkIdType numTuples)=0
Resize the array to the requested number of tuples and preserve data.
void Squeeze() override
Free any unnecessary memory.
virtual vtkArrayIterator * NewIterator()=0
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Insert a value into the array from a variant.
Abstract superclass to iterate over elements in an vtkAbstractArray.
#define VTK_NEWINSTANCE
virtual void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
virtual int Allocate(vtkIdType numValues, vtkIdType ext=1000)=0
Allocate memory for this array.
void save(Archiver &ar, const vtkUnicodeString &str, const unsigned int vtkNotUsed(version))
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
virtual vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple from srcTupleIdx in the source array at the end of this array.
int GetDataType() override
Get the data type.
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.
StdString::value_type value_type
Definition: vtkStdString.h:38
int IsNumeric() override
This method is here to make backward compatibility easier.
virtual unsigned long GetActualMemorySize()=0
Return the memory in kibibytes (1024 bytes) consumed by this data array.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
#define VTK_EXPECTS(x)
virtual void SetVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Set a value in the array from a variant.
void SetVoidArray(void *array, vtkIdType size, int save) override
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...
int GetNumberOfElementComponents()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.