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) VTK_OVERRIDE;
48 
49  //
50  //
51  // Functions required by vtkAbstractArray
52  //
53  //
54 
58  int GetDataType() VTK_OVERRIDE
59  { return VTK_STRING; }
60 
61  int IsNumeric() VTK_OVERRIDE { return 0; }
62 
66  void Initialize() VTK_OVERRIDE;
67 
74  int GetDataTypeSize() VTK_OVERRIDE;
75 
80  void Squeeze() VTK_OVERRIDE { this->ResizeAndExtend (this->MaxId+1); }
81 
85  int Resize(vtkIdType numTuples) VTK_OVERRIDE;
86 
93  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) VTK_OVERRIDE;
94 
99  void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) VTK_OVERRIDE;
100 
106  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
107  vtkAbstractArray *source) VTK_OVERRIDE;
108 
114  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
115  vtkAbstractArray* source) VTK_OVERRIDE;
116 
123 
131  void InterpolateTuple(vtkIdType i, vtkIdList *ptIndices,
132  vtkAbstractArray* source, double* weights) VTK_OVERRIDE;
133 
143  vtkIdType id1, vtkAbstractArray* source1,
144  vtkIdType id2, vtkAbstractArray* source2, double t) VTK_OVERRIDE;
145 
152  void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) VTK_OVERRIDE;
153 
161  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) VTK_OVERRIDE;
162 
167  int Allocate( vtkIdType sz, vtkIdType ext=1000 ) VTK_OVERRIDE;
168 
172  vtkStdString &GetValue(vtkIdType id);
173 
178  void SetValue(vtkIdType id, vtkStdString value)
179  { this->Array[id] = value; this->DataChanged(); }
180 
181  void SetValue(vtkIdType id, const char *value);
182 
187  void SetNumberOfTuples(vtkIdType number) VTK_OVERRIDE
188  { this->SetNumberOfValues(this->NumberOfComponents* number); }
189 
195  void SetNumberOfValues(vtkIdType number) VTK_OVERRIDE;
196 
197  vtkIdType GetNumberOfValues() { return this->MaxId + 1; }
198 
199  int GetNumberOfElementComponents() { return 0; }
200  int GetElementComponentSize() VTK_OVERRIDE { return static_cast<int>(sizeof(vtkStdString::value_type)); }
201 
205  void InsertValue(vtkIdType id, vtkStdString f);
206 
207  void InsertValue(vtkIdType id, const char *val);
208 
213  void SetVariantValue(vtkIdType idx, vtkVariant value) VTK_OVERRIDE;
214 
219  void InsertVariantValue(vtkIdType idx, vtkVariant value) VTK_OVERRIDE;
220 
224  vtkIdType InsertNextValue(vtkStdString f);
225 
226  vtkIdType InsertNextValue(const char *f);
227 
233  vtkStdString* WritePointer(vtkIdType id, vtkIdType number);
234 
239  vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
240  void* GetVoidPointer(vtkIdType id) VTK_OVERRIDE { return this->GetPointer(id); }
241 
246  void DeepCopy( vtkAbstractArray* aa ) VTK_OVERRIDE;
247 
258  void SetArray(vtkStdString* array, vtkIdType size, int save);
259  void SetVoidArray(void* array, vtkIdType size, int save) VTK_OVERRIDE
260  { this->SetArray(static_cast<vtkStdString*>(array), size, save); }
261  void SetVoidArray(void* array, vtkIdType size, int save,
262  int vtkNotUsed(deleteMethod)) VTK_OVERRIDE
263  { this->SetArray(static_cast<vtkStdString*>(array), size, save); }
264 
276  unsigned long GetActualMemorySize() VTK_OVERRIDE;
277 
281  VTK_NEWINSTANCE vtkArrayIterator* NewIterator() VTK_OVERRIDE;
282 
288  vtkIdType GetDataSize() VTK_OVERRIDE;
289 
291 
294  vtkIdType LookupValue(vtkVariant value) VTK_OVERRIDE;
295  void LookupValue(vtkVariant value, vtkIdList* ids) VTK_OVERRIDE;
297 
298  vtkIdType LookupValue(vtkStdString value);
299  void LookupValue(vtkStdString value, vtkIdList* ids);
300 
301  vtkIdType LookupValue(const char* value);
302  void LookupValue(const char* value, vtkIdList* ids);
303 
312  void DataChanged() VTK_OVERRIDE;
313 
319  virtual void DataElementChanged(vtkIdType id);
320 
326  void ClearLookup() VTK_OVERRIDE;
327 
328 protected:
329  vtkStringArray();
330  ~vtkStringArray() VTK_OVERRIDE;
331 
332  vtkStdString* Array; // pointer to data
333  vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
334 
335  int SaveUserArray;
336 
337 private:
338  vtkStringArray(const vtkStringArray&) VTK_DELETE_FUNCTION;
339  void operator=(const vtkStringArray&) VTK_DELETE_FUNCTION;
340 
341  vtkStringArrayLookup* Lookup;
342  void UpdateLookup();
343 
344 };
345 
346 #endif
vtkAbstractArray::Initialize
virtual void Initialize()=0
Release storage and reset array to initial state.
vtkStdString.h
vtkStringArray::GetElementComponentSize
int GetElementComponentSize() override
Return the size, in bytes, of the lowest-level element of an array.
Definition: vtkStringArray.h:200
vtkAbstractArray::InterpolateTuple
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...
vtkAbstractArray::Resize
virtual int Resize(vtkIdType numTuples)=0
Resize the array to the requested number of tuples and preserve data.
vtkAbstractArray::InsertTuple
virtual void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
vtkX3D::value
Definition: vtkX3D.h:220
vtkIdType
int vtkIdType
Definition: vtkType.h:287
vtkAbstractArray::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAbstractArray::InsertNextTuple
virtual vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple from srcTupleIdx in the source array at the end of this array.
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
save
void save(Archiver &ar, const vtkUnicodeString &str, const unsigned int vtkNotUsed(version))
Definition: vtkVariantBoostSerialization.h:65
vtkAbstractArray::InsertTuples
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...
vtkAbstractArray.h
vtkAbstractArray::InsertVariantValue
virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Insert a value into the array from a variant.
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:822
vtkStringArray::GetNumberOfValues
vtkIdType GetNumberOfValues()
Definition: vtkStringArray.h:197
vtkAbstractArray::GetActualMemorySize
virtual unsigned long GetActualMemorySize()=0
Return the memory in kibibytes (1024 bytes) consumed by this data array.
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:61
vtkStringArray::GetVoidPointer
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
Definition: vtkStringArray.h:240
vtkAbstractArray::SetTuple
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.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:75
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:36
vtkStringArray::SetVoidArray
void SetVoidArray(void *array, vtkIdType size, int save) override
Definition: vtkStringArray.h:259
vtkX3D::size
Definition: vtkX3D.h:253
vtkStringArray::SetVoidArray
void SetVoidArray(void *array, vtkIdType size, int save, int vtkNotUsed(deleteMethod)) override
Definition: vtkStringArray.h:261
vtkStringArray::GetDataType
int GetDataType() override
Get the data type.
Definition: vtkStringArray.h:58
vtkStdString::value_type
StdString::value_type value_type
Definition: vtkStdString.h:52
vtkAbstractArray::SetVariantValue
virtual void SetVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Set a value in the array from a variant.
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:78
vtkAbstractArray::DeepCopy
virtual void DeepCopy(vtkAbstractArray *da)
Deep copy of data.
vtkArrayIterator
Abstract superclass to iterate over elements in an vtkAbstractArray.
Definition: vtkArrayIterator.h:49
vtkAbstractArray::GetTuples
virtual void GetTuples(vtkIdList *tupleIds, vtkAbstractArray *output)
Given a list of tuple ids, return an array of tuples.
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:42
vtkStringArray::GetNumberOfElementComponents
int GetNumberOfElementComponents()
Definition: vtkStringArray.h:199
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition: vtkWrappingHints.h:30
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:47
vtkAbstractArray::Allocate
virtual int Allocate(vtkIdType numValues, vtkIdType ext=1000)=0
Allocate memory for this array.
vtkAbstractArray::DataChanged
virtual void DataChanged()=0
Tell the array explicitly that the data has changed.
vtkStringArray::GetPointer
vtkStdString * GetPointer(vtkIdType id)
Get the address of a particular data index.
Definition: vtkStringArray.h:239
vtkStringArray::SetNumberOfTuples
void SetNumberOfTuples(vtkIdType number) override
Set the number of tuples (a component group) in the array.
Definition: vtkStringArray.h:187
vtkAbstractArray::SetNumberOfValues
virtual void SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.