Thanks to visit codestin.com
Credit goes to vtk.org

VTK  9.5.20250920
vtkStringArray.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright 2004 Sandia Corporation
3// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
130#ifndef vtkStringArray_h
131#define vtkStringArray_h
132
133#include "vtkAbstractArray.h"
134#include "vtkCommonCoreModule.h" // For export macro
135#include "vtkStdString.h" // needed for vtkStdString definition
136#include "vtkWrappingHints.h" // For VTK_MARSHALMANUAL
137
138VTK_ABI_NAMESPACE_BEGIN
139class vtkStringArrayLookup;
140
141class VTKCOMMONCORE_EXPORT VTK_MARSHALMANUAL vtkStringArray : public vtkAbstractArray
142{
143public:
145 {
149 VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
150 };
151
155 void PrintSelf(ostream& os, vtkIndent indent) override;
156
157 //
158 //
159 // Functions required by vtkAbstractArray
160 //
161 //
162
166 int GetDataType() const override { return VTK_STRING; }
167
168 int IsNumeric() const override { return 0; }
169
173 void Initialize() override;
174
179 bool CopyComponent(int dstComponent, vtkAbstractArray* src, int srcComponent) override;
180
187 int GetDataTypeSize() const override;
188
193 void Squeeze() override { this->ResizeAndExtend(this->MaxId + 1); }
194
198 vtkTypeBool Resize(vtkIdType numTuples) override;
199
207
213
219 void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
220
222 vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
223
230 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
231
238
247 vtkIdType i, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) override;
248
258 vtkAbstractArray* source2, double t) override;
259
266 void GetTuples(vtkIdList* ptIds, vtkAbstractArray* output) override;
267
275 void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output) override;
276
281 vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
282
287 VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues());
288
293
299 VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues())
300 {
301 this->Array[id] = value;
302 this->DataChanged();
303 }
304
305 void SetValue(vtkIdType id, const char* value)
306 VTK_EXPECTS(0 <= id && id < this->GetNumberOfValues()) VTK_EXPECTS(value != nullptr);
307
312 void SetNumberOfTuples(vtkIdType number) override
313 {
314 this->SetNumberOfValues(this->NumberOfComponents * number);
315 }
316
320 vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
321
323 int GetElementComponentSize() const override
324 {
325 return static_cast<int>(sizeof(vtkStdString::value_type));
326 }
327
332 void InsertValue(vtkIdType id, const char* val) VTK_EXPECTS(0 <= id) VTK_EXPECTS(val != nullptr);
333
338 void SetVariantValue(vtkIdType idx, vtkVariant value) override;
339
344 void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
345
350 vtkIdType InsertNextValue(const char* f) VTK_EXPECTS(f != nullptr);
351
358
363 vtkStdString* GetPointer(vtkIdType id) { return this->Array + id; }
364 void* GetVoidPointer(vtkIdType id) override { return this->GetPointer(id); }
365
370 void DeepCopy(vtkAbstractArray* aa) override;
371
385 vtkStdString* array, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
386 void SetVoidArray(void* array, vtkIdType size, int save) override
387 {
388 this->SetArray(static_cast<vtkStdString*>(array), size, save);
389 }
390 void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override
391 {
392 this->SetArray(static_cast<vtkStdString*>(array), size, save, deleteMethod);
393 }
394
401 void SetArrayFreeFunction(void (*callback)(void*)) override;
402
414 unsigned long GetActualMemorySize() const override;
415
420
426 vtkIdType GetDataSize() const override;
427
429
433 void LookupValue(vtkVariant value, vtkIdList* ids) override;
435
437 void LookupValue(const vtkStdString& value, vtkIdList* ids);
438
439 vtkIdType LookupValue(const char* value);
440 void LookupValue(const char* value, vtkIdList* ids);
441
450 void DataChanged() override;
451
458
464 void ClearLookup() override;
465
466protected:
468 ~vtkStringArray() override;
469
470 vtkStdString* Array; // pointer to data
471 vtkStdString* ResizeAndExtend(vtkIdType sz); // function to resize data
472
473 void (*DeleteFunction)(void*);
474
475private:
476 vtkStringArray(const vtkStringArray&) = delete;
477 void operator=(const vtkStringArray&) = delete;
478
479 vtkStringArrayLookup* Lookup;
480 void UpdateLookup();
481};
482
483VTK_ABI_NAMESPACE_END
484#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:133
a simple class to control print indentation
Definition vtkIndent.h:108
Wrapper around std::string to keep symbols short.
StdString::value_type value_type
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
This method lets the user specify data to be held by the array.
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.
bool CopyComponent(int dstComponent, vtkAbstractArray *src, int srcComponent) override
Copy one component from src into a (potentially different) component of this 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...
void InsertTuplesStartingAt(vtkIdType dstStart, vtkIdList *srcIds, vtkAbstractArray *source) override
Copy the tuples indexed in srcIds from the source array to the tuple locations starting at index dstS...
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
This method lets the user specify data to be held by the array.
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 type representing the union of many types.
Definition vtkVariant.h:162
int vtkTypeBool
Definition vtkABI.h:64
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition vtkType.h:333
#define VTK_STRING
Definition vtkType.h:49
void save(Archiver &ar, const std::string &str, const unsigned int version)
#define VTK_EXPECTS(x)
#define VTK_MARSHALMANUAL
#define VTK_NEWINSTANCE