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:
46  {
49  VTK_DATA_ARRAY_ALIGNED_FREE=vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
50  VTK_DATA_ARRAY_USER_DEFINED=vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
51  };
52 
53  static vtkStringArray* New();
55  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
57  //
58  //
59  // Functions required by vtkAbstractArray
60  //
61  //
62 
66  int GetDataType() override
67  { return VTK_STRING; }
68 
69  int IsNumeric() override { return 0; }
70 
74  void Initialize() override;
75 
82  int GetDataTypeSize() override;
83 
88  void Squeeze() override { this->ResizeAndExtend (this->MaxId+1); }
89 
93  vtkTypeBool Resize(vtkIdType numTuples) override;
94 
102 
108 
114  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
115  vtkAbstractArray *source) override;
116 
122  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
123  vtkAbstractArray* source) override;
124 
131 
140  vtkAbstractArray* source, double* weights) override;
141 
151  vtkIdType id1, vtkAbstractArray* source1,
152  vtkIdType id2, vtkAbstractArray* source2, double t) override;
153 
160  void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) override;
161 
169  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override;
170 
175  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000 ) override;
176 
181  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
182 
188  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
189  { this->Array[id] = value; this->DataChanged(); }
190 
191  void SetValue(vtkIdType id, const char *value)
192  VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
193  VTK_EXPECTS(value != nullptr);
194 
199  void SetNumberOfTuples(vtkIdType number) override
200  { this->SetNumberOfValues(this->NumberOfComponents* number); }
201 
207  void SetNumberOfValues(vtkIdType number) override;
208 
209  vtkIdType GetNumberOfValues() { return this->MaxId + 1; }
210 
211  int GetNumberOfElementComponents() { return 0; }
212  int GetElementComponentSize() override { return static_cast<int>(sizeof(vtkStdString::value_type)); }
213 
218  VTK_EXPECTS(0 <= id);
219  void InsertValue(vtkIdType id, const char *val)
220  VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
221 
227 
233 
238  vtkIdType InsertNextValue(const char *f)
239  VTK_EXPECTS(f != nullptr);
240 
247 
252  vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
253  void* GetVoidPointer(vtkIdType id) override { return this->GetPointer(id); }
254 
259  void DeepCopy( vtkAbstractArray* aa ) override;
260 
273  void SetArray(vtkStdString* array, vtkIdType size, int save, int deleteMethod=VTK_DATA_ARRAY_DELETE);
274  void SetVoidArray(void* array, vtkIdType size, int save) override
275  { this->SetArray(static_cast<vtkStdString*>(array), size, save); }
276  void SetVoidArray(void* array, vtkIdType size, int save,
277  int deleteMethod) override
278  { this->SetArray(static_cast<vtkStdString*>(array), size, save, deleteMethod); }
279 
286  void SetArrayFreeFunction(void (*callback)(void *)) override;
287 
299  unsigned long GetActualMemorySize() override;
300 
305 
311  vtkIdType GetDataSize() override;
312 
314 
318  void LookupValue(vtkVariant value, vtkIdList* ids) override;
320 
323 
325  void LookupValue(const char* value, vtkIdList* ids);
326 
335  void DataChanged() override;
336 
342  virtual void DataElementChanged(vtkIdType id);
343 
349  void ClearLookup() override;
350 
351 protected:
353  ~vtkStringArray() override;
354 
355  vtkStdString* Array; // pointer to data
356  vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
357 
358  void (*DeleteFunction)(void*);
359 
360 private:
361  vtkStringArray(const vtkStringArray&) = delete;
362  void operator=(const vtkStringArray&) = delete;
363 
364  vtkStringArrayLookup* Lookup;
365  void UpdateLookup();
366 
367 };
368 
369 #endif
vtkStringArray::GetValue
vtkStdString & GetValue(vtkIdType id)
Get the data at a particular index.
vtkStringArray::DataElementChanged
virtual void DataElementChanged(vtkIdType id)
Tell the array explicitly that a single data element has changed.
vtkStdString.h
vtkStringArray::GetElementComponentSize
int GetElementComponentSize() override
Return the size, in bytes, of the lowest-level element of an array.
Definition: vtkStringArray.h:212
vtkAbstractArray::DeleteMethod
DeleteMethod
Definition: vtkAbstractArray.h:334
vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE
@ VTK_DATA_ARRAY_ALIGNED_FREE
Definition: vtkAbstractArray.h:337
vtkStringArray::GetDataTypeSize
int GetDataTypeSize() override
Return the size of the data type.
vtkStringArray::LookupValue
void LookupValue(const char *value, vtkIdList *ids)
vtkStringArray::Allocate
vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000) override
Allocate memory for this array.
VTK_EXPECTS
#define VTK_EXPECTS(x)
Definition: vtkWrappingHints.h:41
vtkStringArray::SetValue
void SetValue(vtkIdType id, const char *value)
vtkX3D::value
@ value
Definition: vtkX3D.h:220
vtkAbstractArray::VTK_DATA_ARRAY_DELETE
@ VTK_DATA_ARRAY_DELETE
Definition: vtkAbstractArray.h:336
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkStringArray::Initialize
void Initialize() override
Release storage and reset array to initial state.
vtkStringArray::InterpolateTuple
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,...
save
void save(Archiver &ar, const vtkUnicodeString &str, const unsigned int vtkNotUsed(version))
Definition: vtkVariantBoostSerialization.h:65
vtkStringArray::NewIterator
vtkArrayIterator * NewIterator() override
Returns a vtkArrayIteratorTemplate<vtkStdString>.
vtkStringArray::LookupValue
void LookupValue(vtkVariant value, vtkIdList *ids) override
vtkAbstractArray::VTK_DATA_ARRAY_FREE
@ VTK_DATA_ARRAY_FREE
Definition: vtkAbstractArray.h:335
vtkStringArray::InsertNextValue
vtkIdType InsertNextValue(vtkStdString f)
Insert data at the end of the array.
vtkStringArray::ResizeAndExtend
vtkStdString * ResizeAndExtend(vtkIdType sz)
vtkStringArray::DataChanged
void DataChanged() override
Tell the array explicitly that the data has changed.
vtkAbstractArray.h
vtkStringArray::GetDataSize
vtkIdType GetDataSize() override
Returns the size of the data in DataTypeSize units.
vtkStringArray::GetActualMemorySize
unsigned long GetActualMemorySize() override
Return the memory in kibibytes (1024 bytes) consumed by this data array.
vtkStringArray::InsertTuple
void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at ith location in this array.
vtkStringArray::InsertTuples
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,...
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:825
vtkStringArray::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkStringArray::InsertVariantValue
void InsertVariantValue(vtkIdType idx, vtkVariant value) override
Safely set a value in the array form a variant.
vtkStringArray::LookupValue
void LookupValue(const vtkStdString &value, vtkIdList *ids)
vtkAbstractArray::GetNumberOfValues
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
Definition: vtkAbstractArray.h:183
vtkStringArray::GetNumberOfValues
vtkIdType GetNumberOfValues()
Definition: vtkStringArray.h:209
VTK_STRING
#define VTK_STRING
Definition: vtkType.h:64
vtkStringArray::IsNumeric
int IsNumeric() override
This method is here to make backward compatibility easier.
Definition: vtkStringArray.h:69
vtkStringArray::SetNumberOfValues
void SetNumberOfValues(vtkIdType number) override
Specify the number of values for this object to hold.
vtkStringArray::GetTuples
void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override
Get the values for the range of indices specified (i.e., p1->p2 inclusive).
vtkStringArray::vtkStringArray
vtkStringArray()
vtkStringArray::SetArrayFreeFunction
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...
vtkStringArray::InsertNextTuple
vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at the end in this array.
vtkStringArray::GetVoidPointer
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
Definition: vtkStringArray.h:253
vtkStringArray::SetArray
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.
vtkStringArray::SetTuple
void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Set the tuple at the ith location using the jth tuple in the source array.
vtkStringArray::InterpolateTuple
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...
vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
@ VTK_DATA_ARRAY_USER_DEFINED
Definition: vtkAbstractArray.h:338
vtkStringArray::WritePointer
vtkStdString * WritePointer(vtkIdType id, vtkIdType number)
Get the address of a particular data index.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkStringArray::SetValue
void SetValue(vtkIdType id, vtkStdString value)
Set the data at a particular index.
Definition: vtkStringArray.h:187
vtkStringArray::Resize
vtkTypeBool Resize(vtkIdType numTuples) override
Resize the array while conserving the data.
vtkStringArray::InsertValue
void InsertValue(vtkIdType id, vtkStdString f)
Insert data at a specified position in the array.
vtkStringArray::DeepCopy
void DeepCopy(vtkAbstractArray *aa) override
Deep copy of another string array.
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:72
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:37
vtkStringArray::SetVoidArray
void SetVoidArray(void *array, vtkIdType size, int save) override
Definition: vtkStringArray.h:274
vtkX3D::size
@ size
Definition: vtkX3D.h:253
vtkStringArray::GetDataType
int GetDataType() override
Get the data type.
Definition: vtkStringArray.h:66
vtkStdString::value_type
StdString::value_type value_type
Definition: vtkStdString.h:44
vtkStringArray::ClearLookup
void ClearLookup() override
Delete the associated fast lookup data structure on this array, if it exists.
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:79
vtkStringArray::InsertNextValue
vtkIdType InsertNextValue(const char *f)
vtkStringArray::SetVoidArray
void SetVoidArray(void *array, vtkIdType size, int save, int deleteMethod) override
Definition: vtkStringArray.h:276
vtkStringArray::LookupValue
vtkIdType LookupValue(const vtkStdString &value)
vtkStringArray::LookupValue
vtkIdType LookupValue(vtkVariant value) override
Return the indices where a specific value appears.
vtkArrayIterator
Abstract superclass to iterate over elements in an vtkAbstractArray.
Definition: vtkArrayIterator.h:53
vtkStringArray::SetVariantValue
void SetVariantValue(vtkIdType idx, vtkVariant value) override
Set a value in the array form a variant.
vtkStringArray::Squeeze
void Squeeze() override
Free any unnecessary memory.
Definition: vtkStringArray.h:88
vtkStringArray::InsertTuples
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...
vtkStringArray::~vtkStringArray
~vtkStringArray() override
vtkStringArray::InsertValue
void InsertValue(vtkIdType id, const char *val)
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:43
vtkStringArray::GetTuples
void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) override
Given a list of indices, return an array of values.
vtkStringArray::GetNumberOfElementComponents
int GetNumberOfElementComponents()
Definition: vtkStringArray.h:211
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition: vtkWrappingHints.h:39
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:41
vtkStringArray::Array
vtkStdString * Array
Definition: vtkStringArray.h:355
vtkAbstractArray::DataChanged
virtual void DataChanged()=0
Tell the array explicitly that the data has changed.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkStringArray::GetPointer
vtkStdString * GetPointer(vtkIdType id)
Get the address of a particular data index.
Definition: vtkStringArray.h:252
vtkStringArray::LookupValue
vtkIdType LookupValue(const char *value)
vtkStringArray::New
static vtkStringArray * New()
vtkAbstractArray::SetNumberOfValues
virtual void SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.