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
40class vtkStringArrayLookup;
41
42class VTKCOMMONCORE_EXPORT vtkStringArray : public vtkAbstractArray
43{
44public:
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
94
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
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
200 int GetElementComponentSize() VTK_OVERRIDE { return static_cast<int>(sizeof(vtkStdString::value_type)); }
201
206
207 void InsertValue(vtkIdType id, const char *val);
208
213 void SetVariantValue(vtkIdType idx, vtkVariant value) VTK_OVERRIDE;
214
220
225
227
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
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
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
328protected:
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
337private:
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
Abstract superclass for all arrays.
virtual void SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.
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:37
a simple class to control print indentation
Definition: vtkIndent.h:40
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:49
StdString::value_type value_type
Definition: vtkStdString.h:52
a vtkAbstractArray subclass for strings
void SetVoidArray(void *array, vtkIdType size, int save, int vtkNotUsed(deleteMethod)) override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdType InsertNextValue(const char *f)
unsigned long GetActualMemorySize() override
Return the memory in kibibytes (1024 bytes) consumed by this data array.
vtkIdType InsertNextValue(vtkStdString f)
Insert data at the end of the array.
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
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,...
int GetElementComponentSize() override
Return the size, in bytes, of the lowest-level element of an array.
static vtkStringArray * New()
void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) override
Given a list of indices, return an array of values.
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 InsertValue(vtkIdType id, const char *val)
int IsNumeric() override
This method is here to make backward compatibility easier.
vtkStdString * WritePointer(vtkIdType id, vtkIdType number)
Get the address of a particular data index.
int GetNumberOfElementComponents()
void SetArray(vtkStdString *array, vtkIdType size, int save)
This method lets the user specify data to be held by the 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...
int Allocate(vtkIdType sz, vtkIdType ext=1000) override
Allocate memory for this array.
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).
void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at ith location in this array.
vtkIdType GetNumberOfValues()
void SetValue(vtkIdType id, const char *value)
vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at the end in this array.
void SetNumberOfValues(vtkIdType number) override
Specify the number of values for this object to hold.
void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Set the tuple at the ith location using the jth tuple in the source array.
int GetDataType() override
Get the data type.
int Resize(vtkIdType numTuples) override
Resize the array while conserving the data.
vtkStdString * GetPointer(vtkIdType id)
Get the address of a particular data index.
void SetVoidArray(void *array, vtkIdType size, int save) override
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,...
void SetNumberOfTuples(vtkIdType number) override
Set the number of tuples (a component group) in the array.
A atomic type representing the union of many types.
Definition: vtkVariant.h:76
@ value
Definition: vtkX3D.h:220
@ size
Definition: vtkX3D.h:253
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition: vtkType.h:287
#define VTK_STRING
Definition: vtkType.h:64
void save(Archiver &ar, const vtkUnicodeString &str, const unsigned int vtkNotUsed(version))
#define VTK_NEWINSTANCE