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 
33 #ifndef vtkStringArray_h
34 #define vtkStringArray_h
35 
36 #include "vtkCommonCoreModule.h" // For export macro
37 #include "vtkAbstractArray.h"
38 #include "vtkStdString.h" // needed for vtkStdString definition
39 
40 class vtkStringArrayLookup;
41 
42 class VTKCOMMONCORE_EXPORT vtkStringArray : public vtkAbstractArray
43 {
44 public:
45  static vtkStringArray* New();
47  void PrintSelf(ostream& os, vtkIndent indent) override;
48 
49  //
50  //
51  // Functions required by vtkAbstractArray
52  //
53  //
54 
58  int GetDataType() override
59  { return VTK_STRING; }
60 
61  int IsNumeric() override { return 0; }
62 
66  void Initialize() override;
67 
74  int GetDataTypeSize() override;
75 
80  void Squeeze() override { this->ResizeAndExtend (this->MaxId+1); }
81 
85  int Resize(vtkIdType numTuples) override;
86 
93  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
94 
100 
106  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
107  vtkAbstractArray *source) override;
108 
114  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
115  vtkAbstractArray* source) override;
116 
123 
131  void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices,
132  vtkAbstractArray* source, double* weights) override;
133 
143  vtkIdType id1, vtkAbstractArray* source1,
144  vtkIdType id2, 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  int Allocate( vtkIdType sz, vtkIdType ext=1000 ) override;
168 
172  vtkStdString &GetValue(vtkIdType id)
173  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
174 
180  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
181  { this->Array[id] = value; this->DataChanged(); }
182 
183  void SetValue(vtkIdType id, const char *value)
184  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
185  VTK_EXPECTS(value != nullptr);
186 
191  void SetNumberOfTuples(vtkIdType number) override
192  { this->SetNumberOfValues(this->NumberOfComponents* number); }
193 
199  void SetNumberOfValues(vtkIdType number) override;
200 
201  vtkIdType GetNumberOfValues() { return this->MaxId + 1; }
202 
203  int GetNumberOfElementComponents() { return 0; }
204  int GetElementComponentSize() override { return static_cast<int>(sizeof(vtkStdString::value_type)); }
205 
209  void InsertValue(vtkIdType id, vtkStdString f)
210  VTK_EXPECTS(0 <= id);
211  void InsertValue(vtkIdType id, const char *val)
212  VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
213 
218  void SetVariantValue(vtkIdType idx, vtkVariant value) override;
219 
224  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
225 
229  vtkIdType InsertNextValue(vtkStdString f);
230  vtkIdType InsertNextValue(const char *f)
231  VTK_EXPECTS(f != nullptr);
232 
238  vtkStdString* WritePointer(vtkIdType id, vtkIdType number);
239 
244  vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
245  void* GetVoidPointer(vtkIdType id) override { return this->GetPointer(id); }
246 
251  void DeepCopy( vtkAbstractArray* aa ) override;
252 
263  void SetArray(vtkStdString* array, vtkIdType size, int save);
264  void SetVoidArray(void* array, vtkIdType size, int save) override
265  { this->SetArray(static_cast<vtkStdString*>(array), size, save); }
266  void SetVoidArray(void* array, vtkIdType size, int save,
267  int vtkNotUsed(deleteMethod)) override
268  { this->SetArray(static_cast<vtkStdString*>(array), size, save); }
269 
281  unsigned long GetActualMemorySize() override;
282 
287 
293  vtkIdType GetDataSize() override;
294 
296 
300  void LookupValue(vtkVariant value, vtkIdList* ids) override;
302 
304  void LookupValue(const vtkStdString& value, vtkIdList* ids);
305 
306  vtkIdType LookupValue(const char* value);
307  void LookupValue(const char* value, vtkIdList* ids);
308 
317  void DataChanged() override;
318 
324  virtual void DataElementChanged(vtkIdType id);
325 
331  void ClearLookup() override;
332 
333 protected:
334  vtkStringArray();
335  ~vtkStringArray() override;
336 
337  vtkStdString* Array; // pointer to data
338  vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
339 
341 
342 private:
343  vtkStringArray(const vtkStringArray&) = delete;
344  void operator=(const vtkStringArray&) = delete;
345 
346  vtkStringArrayLookup* Lookup;
347  void UpdateLookup();
348 
349 };
350 
351 #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:40
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:70
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:39
list of point or cell ids
Definition: vtkIdList.h:36
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:44
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.