VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkUnicodeStringArray Class Reference

Subclass of vtkAbstractArray that holds vtkUnicodeStrings. More...

#include <vtkUnicodeStringArray.h>

Inheritance diagram for vtkUnicodeStringArray:
[legend]
Collaboration diagram for vtkUnicodeStringArray:
[legend]

Public Types

typedef vtkAbstractArray Superclass
 
- Public Types inherited from vtkAbstractArray
enum  DeleteMethod { VTK_DATA_ARRAY_FREE, VTK_DATA_ARRAY_DELETE, VTK_DATA_ARRAY_ALIGNED_FREE, VTK_DATA_ARRAY_USER_DEFINED }
 
enum  { MAX_DISCRETE_VALUES = 32 }
 
enum  {
  AbstractArray = 0, DataArray, AoSDataArrayTemplate, SoADataArrayTemplate,
  TypedDataArray, MappedDataArray, ScaleSoADataArrayTemplate, DataArrayTemplate = AoSDataArrayTemplate
}
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkUnicodeStringArrayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkTypeBool Allocate (vtkIdType sz, vtkIdType ext=1000) override
 Allocate memory for this array. More...
 
void Initialize () override
 Release storage and reset array to initial state. More...
 
int GetDataType () override
 Return the underlying data type. More...
 
int GetDataTypeSize () override
 Return the size of the underlying data type. More...
 
int GetElementComponentSize () override
 Return the size, in bytes, of the lowest-level element of an array. More...
 
void SetNumberOfTuples (vtkIdType number) override
 Set the number of tuples (a component group) in the array. More...
 
void SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
 Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array. More...
 
void InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
 Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx. More...
 
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 this array. More...
 
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, starting at the dstStart location. More...
 
vtkIdType InsertNextTuple (vtkIdType j, vtkAbstractArray *source) override
 Insert the tuple from srcTupleIdx in the source array at the end of this array. More...
 
void * GetVoidPointer (vtkIdType id) override
 Return a void pointer. More...
 
void DeepCopy (vtkAbstractArray *da) override
 Deep copy of data. More...
 
void InterpolateTuple (vtkIdType i, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights) override
 Set the tuple at dstTupleIdx in this array to the interpolated tuple value, given the ptIndices in the source array and associated interpolation weights. More...
 
void InterpolateTuple (vtkIdType i, vtkIdType id1, vtkAbstractArray *source1, vtkIdType id2, vtkAbstractArray *source2, double t) override
 Insert the tuple at dstTupleIdx in this array to the tuple interpolated from the two tuple indices, srcTupleIdx1 and srcTupleIdx2, and an interpolation factor, t. More...
 
void Squeeze () override
 Free any unnecessary memory. More...
 
vtkTypeBool Resize (vtkIdType numTuples) override
 Resize the array to the requested number of tuples and preserve data. More...
 
void SetVoidArray (void *array, vtkIdType size, int save) override
 
void SetVoidArray (void *array, vtkIdType size, int save, int deleteMethod) override
 
void SetArrayFreeFunction (void(*callback)(void *)) override
 This method allows the user to specify a custom free function to be called when the array is deallocated. More...
 
unsigned long GetActualMemorySize () override
 Return the memory in kibibytes (1024 bytes) consumed by this data array. More...
 
int IsNumeric () override
 This method is here to make backward compatibility easier. More...
 
vtkArrayIteratorNewIterator () override
 Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate. More...
 
vtkVariant GetVariantValue (vtkIdType idx) override
 Retrieve value from the array as a variant. More...
 
vtkIdType LookupValue (vtkVariant value) override
 Return the value indices where a specific value appears. More...
 
void LookupValue (vtkVariant value, vtkIdList *ids) override
 
void SetVariantValue (vtkIdType idx, vtkVariant value) override
 Set a value in the array from a variant. More...
 
void InsertVariantValue (vtkIdType idx, vtkVariant value) override
 Insert a value into the array from a variant. More...
 
void DataChanged () override
 Tell the array explicitly that the data has changed. More...
 
void ClearLookup () override
 Delete the associated fast lookup data structure on this array, if it exists. More...
 
vtkIdType InsertNextValue (const vtkUnicodeString &)
 
void InsertValue (vtkIdType idx, const vtkUnicodeString &)
 
void SetValue (vtkIdType i, const vtkUnicodeString &)
 
vtkUnicodeStringGetValue (vtkIdType i)
 
void InsertNextUTF8Value (const char *)
 
void SetUTF8Value (vtkIdType i, const char *)
 
const char * GetUTF8Value (vtkIdType i)
 
- Public Member Functions inherited from vtkAbstractArray
vtkAbstractArrayNewInstance () const
 
virtual void SetNumberOfComponents (int)
 Set/Get the dimension (n) of the components. More...
 
int GetNumberOfComponents ()
 
void SetComponentName (vtkIdType component, const char *name)
 Set the name for a component. More...
 
const char * GetComponentName (vtkIdType component)
 Get the component name for a given component. More...
 
bool HasAComponentName ()
 Returns if any component has had a name assigned. More...
 
int CopyComponentNames (vtkAbstractArray *da)
 Copies the component names from the inputed array to the current array make sure that the current array has the same number of components as the input array. More...
 
virtual bool SetNumberOfValues (vtkIdType numValues)
 Specify the number of values (tuples * components) for this object to hold. More...
 
vtkIdType GetNumberOfTuples ()
 Get the number of complete tuples (a component group) in the array. More...
 
vtkIdType GetNumberOfValues () const
 Get the total number of values in the array. More...
 
virtual void GetTuples (vtkIdList *tupleIds, vtkAbstractArray *output)
 Given a list of tuple ids, return an array of tuples. More...
 
virtual void GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output)
 Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive). More...
 
virtual bool HasStandardMemoryLayout ()
 Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g. More...
 
void Reset ()
 Reset to an empty state, without freeing any memory. More...
 
vtkIdType GetSize () const
 Return the size of the data. More...
 
vtkIdType GetMaxId () const
 What is the maximum id currently in the array. More...
 
virtual void SetVoidArray (void *vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save))=0
 This method lets the user specify data to be held by the array. More...
 
virtual void SetVoidArray (void *array, vtkIdType size, int save, int vtkNotUsed(deleteMethod))
 
virtual void ExportToVoidPointer (void *out_ptr)
 This method copies the array data to the void pointer specified by the user. More...
 
virtual void SetName (const char *)
 Set/get array's name. More...
 
virtual char * GetName ()
 
virtual const char * GetDataTypeAsString (void)
 Get the name of a data type as a string. More...
 
virtual vtkIdType GetDataSize ()
 Returns the size of the data in DataTypeSize units. More...
 
virtual void GetProminentComponentValues (int comp, vtkVariantArray *values, double uncertainty=1.e-6, double minimumProminence=1.e-3)
 Populate the given vtkVariantArray with a set of distinct values taken on by the requested component (or, when passed -1, by the tuples as a whole). More...
 
vtkInformationGetInformation ()
 Get an information object that can be used to annotate the array. More...
 
bool HasInformation ()
 Inquire if this array has an instance of vtkInformation already associated with it. More...
 
virtual int CopyInformation (vtkInformation *infoFrom, int deep=1)
 Copy information instance. More...
 
void Modified () override
 Removes out-of-date PER_COMPONENT() and PER_FINITE_COMPONENT() values. More...
 
virtual unsigned int GetMaxDiscreteValues ()
 Get/Set the maximum number of prominent values this array may contain before it is considered continuous. More...
 
virtual void SetMaxDiscreteValues (unsigned int)
 
virtual int GetArrayType ()
 Method for type-checking in FastDownCast implementations. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkUnicodeStringArrayNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnicodeStringArraySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractArray
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractArraySafeDownCast (vtkObjectBase *o)
 
static int GetDataTypeSize (int type)
 
static vtkAbstractArrayCreateArray (int dataType)
 Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_DOUBLE, VTK_ID_TYPE, VTK_STRING. More...
 
static vtkInformationIntegerKeyGUI_HIDE ()
 This key is a hint to end user interface that this array is internal and should not be shown to the end user. More...
 
static vtkInformationInformationVectorKeyPER_COMPONENT ()
 This key is used to hold a vector of COMPONENT_VALUES (and, for vtkDataArray subclasses, COMPONENT_RANGE) keys – one for each component of the array. More...
 
static vtkInformationInformationVectorKeyPER_FINITE_COMPONENT ()
 This key is used to hold a vector of COMPONENT_VALUES (and, for vtkDataArray subclasses, COMPONENT_RANGE) keys – one for each component of the array. More...
 
static vtkInformationVariantVectorKeyDISCRETE_VALUES ()
 A key used to hold discrete values taken on either by the tuples of the array (when present in this->GetInformation()) or individual components (when present in one entry of the PER_COMPONENT() information vector). More...
 
static vtkInformationDoubleVectorKeyDISCRETE_VALUE_SAMPLE_PARAMETERS ()
 A key used to hold conditions under which cached discrete values were generated; the value is a 2-vector of doubles. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkUnicodeStringArray ()
 
 ~vtkUnicodeStringArray () override
 
- Protected Member Functions inherited from vtkAbstractArray
 vtkAbstractArray ()
 
 ~vtkAbstractArray () override
 
virtual void SetInformation (vtkInformation *)
 Set an information object that can be used to annotate the array. More...
 
virtual void UpdateDiscreteValueSet (double uncertainty, double minProminence)
 Obtain the set of unique values taken on by each component of the array, as well as by the tuples of the array. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkAbstractArray
vtkIdType Size
 
vtkIdType MaxId
 
int NumberOfComponents
 
unsigned int MaxDiscreteValues
 
char * Name
 
bool RebuildArray
 
vtkInformationInformation
 
vtkInternalComponentNames * ComponentNames
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Subclass of vtkAbstractArray that holds vtkUnicodeStrings.

Thanks:
Developed by Timothy M. Shead (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.

Definition at line 39 of file vtkUnicodeStringArray.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkUnicodeStringArray.h.

Constructor & Destructor Documentation

◆ vtkUnicodeStringArray()

vtkUnicodeStringArray::vtkUnicodeStringArray ( )
protected

◆ ~vtkUnicodeStringArray()

vtkUnicodeStringArray::~vtkUnicodeStringArray ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkUnicodeStringArray* vtkUnicodeStringArray::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkUnicodeStringArray::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkUnicodeStringArray::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractArray.

◆ SafeDownCast()

static vtkUnicodeStringArray* vtkUnicodeStringArray::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkUnicodeStringArray::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractArray.

◆ NewInstance()

vtkUnicodeStringArray* vtkUnicodeStringArray::NewInstance ( ) const

◆ PrintSelf()

void vtkUnicodeStringArray::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractArray.

◆ Allocate()

vtkTypeBool vtkUnicodeStringArray::Allocate ( vtkIdType  numValues,
vtkIdType  ext = 1000 
)
overridevirtual

Allocate memory for this array.

Delete old storage only if necessary. Note that ext is no longer used. This method will reset MaxId to -1 and resize the array capacity such that this->Size >= numValues. If numValues is 0, all memory will be freed. Return 1 on success, 0 on failure.

Implements vtkAbstractArray.

◆ Initialize()

void vtkUnicodeStringArray::Initialize ( )
overridevirtual

Release storage and reset array to initial state.

Implements vtkAbstractArray.

◆ GetDataType()

int vtkUnicodeStringArray::GetDataType ( )
overridevirtual

Return the underlying data type.

An integer indicating data type is returned as specified in vtkType.h.

Implements vtkAbstractArray.

◆ GetDataTypeSize()

int vtkUnicodeStringArray::GetDataTypeSize ( )
overridevirtual

Return the size of the underlying data type.

For a bit, 0 is returned. For string 0 is returned. Arrays with variable length components return 0.

Implements vtkAbstractArray.

◆ GetElementComponentSize()

int vtkUnicodeStringArray::GetElementComponentSize ( )
overridevirtual

Return the size, in bytes, of the lowest-level element of an array.

For vtkDataArray and subclasses this is the size of the data type. For vtkStringArray, this is sizeof(vtkStdString::value_type), which winds up being sizeof(char).

Implements vtkAbstractArray.

◆ SetNumberOfTuples()

void vtkUnicodeStringArray::SetNumberOfTuples ( vtkIdType  numTuples)
overridevirtual

Set the number of tuples (a component group) in the array.

Note that this may allocate space depending on the number of components. Also note that if allocation is performed no copy is performed so existing data will be lost (if data conservation is sought, one may use the Resize method instead).

Implements vtkAbstractArray.

◆ SetTuple()

void vtkUnicodeStringArray::SetTuple ( vtkIdType  dstTupleIdx,
vtkIdType  srcTupleIdx,
vtkAbstractArray source 
)
overridevirtual

Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array.

This method assumes that the two arrays have the same type and structure. Note that range checking and memory allocation is not performed; use in conjunction with SetNumberOfTuples() to allocate space.

Implements vtkAbstractArray.

◆ InsertTuple()

void vtkUnicodeStringArray::InsertTuple ( vtkIdType  dstTupleIdx,
vtkIdType  srcTupleIdx,
vtkAbstractArray source 
)
overridevirtual

Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.

Note that memory allocation is performed as necessary to hold the data.

Implements vtkAbstractArray.

◆ InsertTuples() [1/2]

void vtkUnicodeStringArray::InsertTuples ( vtkIdList dstIds,
vtkIdList srcIds,
vtkAbstractArray source 
)
overridevirtual

Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array.

Note that memory allocation is performed as necessary to hold the data.

Implements vtkAbstractArray.

◆ InsertTuples() [2/2]

void vtkUnicodeStringArray::InsertTuples ( vtkIdType  dstStart,
vtkIdType  n,
vtkIdType  srcStart,
vtkAbstractArray source 
)
overridevirtual

Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location.

Note that memory allocation is performed as necessary to hold the data.

Implements vtkAbstractArray.

◆ InsertNextTuple()

vtkIdType vtkUnicodeStringArray::InsertNextTuple ( vtkIdType  srcTupleIdx,
vtkAbstractArray source 
)
overridevirtual

Insert the tuple from srcTupleIdx in the source array at the end of this array.

Note that memory allocation is performed as necessary to hold the data. Returns the tuple index at which the data was inserted.

Implements vtkAbstractArray.

◆ GetVoidPointer()

void* vtkUnicodeStringArray::GetVoidPointer ( vtkIdType  valueIdx)
overridevirtual

Return a void pointer.

For image pipeline interface and other special pointer manipulation. Use of this method is discouraged, as newer arrays require a deep-copy of the array data in order to return a suitable pointer. See vtkArrayDispatch for a safer alternative for fast data access.

Implements vtkAbstractArray.

◆ DeepCopy()

void vtkUnicodeStringArray::DeepCopy ( vtkAbstractArray da)
overridevirtual

Deep copy of data.

Implementation left to subclasses, which should support as many type conversions as possible given the data type.

Subclasses should call vtkAbstractArray::DeepCopy() so that the information object (if one exists) is copied from da.

Reimplemented from vtkAbstractArray.

◆ InterpolateTuple() [1/2]

void vtkUnicodeStringArray::InterpolateTuple ( vtkIdType  dstTupleIdx,
vtkIdList ptIndices,
vtkAbstractArray source,
double *  weights 
)
overridevirtual

Set the tuple at dstTupleIdx in this array to the interpolated tuple value, given the ptIndices in the source array and associated interpolation weights.

This method assumes that the two arrays are of the same type and structure.

Implements vtkAbstractArray.

◆ InterpolateTuple() [2/2]

void vtkUnicodeStringArray::InterpolateTuple ( vtkIdType  dstTupleIdx,
vtkIdType  srcTupleIdx1,
vtkAbstractArray source1,
vtkIdType  srcTupleIdx2,
vtkAbstractArray source2,
double  t 
)
overridevirtual

Insert the tuple at dstTupleIdx in this array to the tuple interpolated from the two tuple indices, srcTupleIdx1 and srcTupleIdx2, and an interpolation factor, t.

The interpolation factor ranges from (0,1), with t=0 located at the tuple described by srcTupleIdx1. This method assumes that the three arrays are of the same type, srcTupleIdx1 is an index to array source1, and srcTupleIdx2 is an index to array source2.

Implements vtkAbstractArray.

◆ Squeeze()

void vtkUnicodeStringArray::Squeeze ( )
overridevirtual

Free any unnecessary memory.

Description: Resize object to just fit data requirement. Reclaims extra memory.

Implements vtkAbstractArray.

◆ Resize()

vtkTypeBool vtkUnicodeStringArray::Resize ( vtkIdType  numTuples)
overridevirtual

Resize the array to the requested number of tuples and preserve data.

Increasing the array size may allocate extra memory beyond what was requested. MaxId will not be modified when increasing array size. Decreasing the array size will trim memory to the requested size and may update MaxId if the valid id range is truncated. Requesting an array size of 0 will free all memory. Returns 1 if resizing succeeded and 0 otherwise.

Implements vtkAbstractArray.

◆ SetVoidArray() [1/2]

void vtkUnicodeStringArray::SetVoidArray ( void *  array,
vtkIdType  size,
int  save 
)
override

◆ SetVoidArray() [2/2]

void vtkUnicodeStringArray::SetVoidArray ( void *  array,
vtkIdType  size,
int  save,
int  deleteMethod 
)
override

◆ SetArrayFreeFunction()

void vtkUnicodeStringArray::SetArrayFreeFunction ( void(*)(void *)  callback)
overridevirtual

This method allows the user to specify a custom free function to be called when the array is deallocated.

Calling this method will implicitly mean that the given free function will be called when the class cleans up or reallocates memory.

Implements vtkAbstractArray.

◆ GetActualMemorySize()

unsigned long vtkUnicodeStringArray::GetActualMemorySize ( )
overridevirtual

Return the memory in kibibytes (1024 bytes) consumed by this data array.

Used to support streaming and reading/writing data. The value returned is guaranteed to be greater than or equal to the memory required to actually represent the data represented by this object. The information returned is valid only after the pipeline has been updated.

Implements vtkAbstractArray.

◆ IsNumeric()

int vtkUnicodeStringArray::IsNumeric ( )
overridevirtual

This method is here to make backward compatibility easier.

It must return true if and only if an array contains numeric data.

Implements vtkAbstractArray.

◆ NewIterator()

vtkArrayIterator* vtkUnicodeStringArray::NewIterator ( )
overridevirtual

Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate.

Implements vtkAbstractArray.

◆ GetVariantValue()

vtkVariant vtkUnicodeStringArray::GetVariantValue ( vtkIdType  valueIdx)
overridevirtual

Retrieve value from the array as a variant.

Reimplemented from vtkAbstractArray.

◆ LookupValue() [1/2]

vtkIdType vtkUnicodeStringArray::LookupValue ( vtkVariant  value)
overridevirtual

Return the value indices where a specific value appears.

Implements vtkAbstractArray.

◆ LookupValue() [2/2]

void vtkUnicodeStringArray::LookupValue ( vtkVariant  value,
vtkIdList ids 
)
overridevirtual

Implements vtkAbstractArray.

◆ SetVariantValue()

void vtkUnicodeStringArray::SetVariantValue ( vtkIdType  valueIdx,
vtkVariant  value 
)
overridevirtual

Set a value in the array from a variant.

This method does NOT do bounds checking.

Implements vtkAbstractArray.

◆ InsertVariantValue()

void vtkUnicodeStringArray::InsertVariantValue ( vtkIdType  valueIdx,
vtkVariant  value 
)
overridevirtual

Insert a value into the array from a variant.

This method does bounds checking.

Implements vtkAbstractArray.

◆ DataChanged()

void vtkUnicodeStringArray::DataChanged ( )
overridevirtual

Tell the array explicitly that the data has changed.

This is only necessary to call when you modify the array contents without using the array's API (i.e. you retrieve a pointer to the data and modify the array contents). You need to call this so that the fast lookup will know to rebuild itself. Otherwise, the lookup functions will give incorrect results.

Implements vtkAbstractArray.

◆ ClearLookup()

void vtkUnicodeStringArray::ClearLookup ( )
overridevirtual

Delete the associated fast lookup data structure on this array, if it exists.

The lookup will be rebuilt on the next call to a lookup function.

Implements vtkAbstractArray.

◆ InsertNextValue()

vtkIdType vtkUnicodeStringArray::InsertNextValue ( const vtkUnicodeString )

◆ InsertValue()

void vtkUnicodeStringArray::InsertValue ( vtkIdType  idx,
const vtkUnicodeString  
)

◆ SetValue()

void vtkUnicodeStringArray::SetValue ( vtkIdType  i,
const vtkUnicodeString  
)

◆ GetValue()

vtkUnicodeString& vtkUnicodeStringArray::GetValue ( vtkIdType  i)

◆ InsertNextUTF8Value()

void vtkUnicodeStringArray::InsertNextUTF8Value ( const char *  )

◆ SetUTF8Value()

void vtkUnicodeStringArray::SetUTF8Value ( vtkIdType  i,
const char *   
)

◆ GetUTF8Value()

const char* vtkUnicodeStringArray::GetUTF8Value ( vtkIdType  i)

The documentation for this class was generated from the following file: