VTK  9.1.0
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
136#ifndef vtkStringArray_h
137#define vtkStringArray_h
138
139#include "vtkAbstractArray.h"
140#include "vtkCommonCoreModule.h" // For export macro
141#include "vtkStdString.h" // needed for vtkStdString definition
142
143class vtkStringArrayLookup;
144
145class VTKCOMMONCORE_EXPORT vtkStringArray : public vtkAbstractArray
146{
147public:
149 {
153 VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
154 };
155
159 void PrintSelf(ostream& os, vtkIndent indent) override;
160
161 //
162 //
163 // Functions required by vtkAbstractArray
164 //
165 //
166
170 int GetDataType() const override { return VTK_STRING; }
171
172 int IsNumeric() const override { return 0; }
173
177 void Initialize() override;
178
185 int GetDataTypeSize() const override;
186
191 void Squeeze() override { this->ResizeAndExtend(this->MaxId + 1); }
192
196 vtkTypeBool Resize(vtkIdType numTuples) override;
197
205
211
217 void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
218
225 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
226
233
242 vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
243
253 vtkAbstractArray* source2, double t) override;
254
261 void GetTuples(vtkIdList* ptIds, vtkAbstractArray* output) override;
262
270 void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output) override;
271
276 vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
277
282 VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
283
288
294 VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
295 {
296 this->Array[id] = value;
297 this->DataChanged();
298 }
299
300 void SetValue(vtkIdType id, const char* value)
301 VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues()) VTK_EXPECTS(value != nullptr);
302
307 void SetNumberOfTuples(vtkIdType number) override
308 {
309 this->SetNumberOfValues(this->NumberOfComponents * number);
310 }
311
315 vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
316
318 int GetElementComponentSize() const override
319 {
320 return static_cast<int>(sizeof(vtkStdString::value_type));
321 }
322
327 void InsertValue(vtkIdType id, const char* val) VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
328
333 void SetVariantValue(vtkIdType idx, vtkVariant value) override;
334
339 void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
340
345 vtkIdType InsertNextValue(const char* f) VTK_EXPECTS(f != nullptr);
346
353
358 vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
359 void* GetVoidPointer(vtkIdType id) override { return this->GetPointer(id); }
360
365 void DeepCopy(vtkAbstractArray* aa) override;
366
380 vtkStdString* array, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
381 void SetVoidArray(void* array, vtkIdType size, int save) override
382 {
383 this->SetArray(static_cast<vtkStdString*>(array), size, save);
384 }
385 void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override
386 {
387 this->SetArray(static_cast<vtkStdString*>(array), size, save, deleteMethod);
388 }
389
396 void SetArrayFreeFunction(void (*callback)(void*)) override;
397
409 unsigned long GetActualMemorySize() const override;
410
415
421 vtkIdType GetDataSize() const override;
422
424
428 void LookupValue(vtkVariant value, vtkIdList* ids) override;
430
432 void LookupValue(const vtkStdString& value, vtkIdList* ids);
433
434 vtkIdType LookupValue(const char* value);
435 void LookupValue(const char* value, vtkIdList* ids);
436
445 void DataChanged() override;
446
453
459 void ClearLookup() override;
460
461protected:
463 ~vtkStringArray() override;
464
465 vtkStdString* Array; // pointer to data
466 vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
467
468 void (*DeleteFunction)(void*);
469
470private:
471 vtkStringArray(const vtkStringArray&) = delete;
472 void operator=(const vtkStringArray&) = delete;
473
474 vtkStringArrayLookup* Lookup;
475 void UpdateLookup();
476};
477
478#endif
Abstract superclass for all arrays.
virtual bool SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.
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.
Abstract superclass to iterate over elements in an vtkAbstractArray.
list of point or cell ids
Definition: vtkIdList.h:140
a simple class to control print indentation
Definition: vtkIndent.h:113
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:105
StdString::value_type value_type
Definition: vtkStdString.h:108
a vtkAbstractArray subclass for strings
int GetDataType() const override
Get the data type.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdType InsertNextValue(const char *f)
void SetVoidArray(void *array, vtkIdType size, int save, int deleteMethod) override
vtkArrayIterator * NewIterator() override
Returns a vtkArrayIteratorTemplate<vtkStdString>.
static vtkStringArray * ExtendedNew()
vtkStdString * Array
vtkIdType InsertNextValue(vtkStdString f)
Insert data at the end of the array.
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
int GetElementComponentSize() const override
Return the size, in bytes, of the lowest-level element of an array.
vtkIdType GetNumberOfValues() const
Return the number of values in the array.
void Squeeze() override
Free any unnecessary memory.
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,...
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...
virtual void DataElementChanged(vtkIdType id)
Tell the array explicitly that a single data element has changed.
void LookupValue(const vtkStdString &value, vtkIdList *ids)
vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000) override
Allocate memory for this array.
static vtkStringArray * New()
vtkIdType LookupValue(vtkVariant value) override
Return the indices where a specific value appears.
void GetTuples(vtkIdList *ptIds, vtkAbstractArray *output) override
Given a list of indices, return an array of values.
vtkStdString * ResizeAndExtend(vtkIdType sz)
void ClearLookup() override
Delete the associated fast lookup data structure on this array, if it exists.
vtkIdType GetDataSize() const override
Returns the size of the data in DataTypeSize units.
void LookupValue(const char *value, vtkIdList *ids)
vtkStdString & GetValue(vtkIdType id)
Get the string at a particular index.
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 LookupValue(vtkVariant value, vtkIdList *ids) override
Return the indices where a specific value appears.
void InsertValue(vtkIdType id, const char *val)
vtkStdString * WritePointer(vtkIdType id, vtkIdType number)
Get the address of a particular data index.
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.
int GetNumberOfElementComponents()
unsigned long GetActualMemorySize() const override
Return the memory in kibibytes (1024 bytes) consumed by this data 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...
vtkIdType LookupValue(const vtkStdString &value)
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).
vtkIdType LookupValue(const char *value)
void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Insert the jth tuple in the source array, at ith location in this array.
vtkTypeBool Resize(vtkIdType numTuples) override
Resize the array while conserving the data.
~vtkStringArray() override
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.
const vtkStdString & GetValue(vtkIdType id) const
Read-access of string at a particular index.
void SetValue(vtkIdType id, vtkStdString value)
Set the data at a particular index.
void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
Set the tuple at the ith location using the jth tuple in the source array.
void DataChanged() override
Tell the array explicitly that the data has changed.
int IsNumeric() const override
This method is here to make backward compatibility easier.
vtkStdString * GetPointer(vtkIdType id)
Get the address of a particular data index.
void SetVoidArray(void *array, vtkIdType size, int save) override
int GetDataTypeSize() const override
Return the size of the data type.
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,...
A atomic type representing the union of many types.
Definition: vtkVariant.h:145
int vtkTypeBool
Definition: vtkABI.h:69
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition: vtkType.h:332
#define VTK_STRING
Definition: vtkType.h:60
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
#define VTK_EXPECTS(x)
#define VTK_NEWINSTANCE