VTK  9.0.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkTypedDataArray< Scalar > Class Template Referenceabstract

Extend vtkDataArray with abstract type-specific API. More...

#include <vtkTypedDataArray.h>

Inheritance diagram for vtkTypedDataArray< Scalar >:
[legend]
Collaboration diagram for vtkTypedDataArray< Scalar >:
[legend]

Public Types

enum  { VTK_DATA_TYPE = vtkTypeTraits<ValueType>::VTK_TYPE_ID }
 Compile time access to the VTK type identifier. More...
 
typedef Superclass::ValueType ValueType
 
typedef vtkTypedDataArrayIterator< ValueTypeIterator
 Typedef to a suitable iterator class. More...
 
- Public Types inherited from vtkGenericDataArray< vtkTypedDataArray< Scalar >, Scalar >
enum  
 Compile time access to the VTK type identifier. More...
 
typedef Scalar ValueType
 
- Public Types inherited from vtkDataArray
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

 vtkTemplateTypeMacro (vtkTypedDataArray< Scalar >, GenericDataArrayType)
 
Iterator Begin ()
 Return an iterator initialized to the first element of the data. More...
 
Iterator End ()
 Return an iterator initialized to first element past the end of the data. More...
 
int GetDataType () const override
 Return the VTK data type held by this array. More...
 
int GetDataTypeSize () const override
 Return the size of the element type in bytes. More...
 
virtual void SetTypedTuple (vtkIdType i, const ValueType *t)=0
 Set the tuple value at the ith location in the array. More...
 
virtual void InsertTypedTuple (vtkIdType i, const ValueType *t)=0
 Insert (memory allocation performed) the tuple into the ith location in the array. More...
 
virtual vtkIdType InsertNextTypedTuple (const ValueType *t)=0
 Insert (memory allocation performed) the tuple onto the end of the array. More...
 
virtual ValueType GetValue (vtkIdType idx) const =0
 Get the data at a particular index. More...
 
virtual ValueTypeGetValueReference (vtkIdType idx)=0
 Get a reference to the scalar value at a particular index. More...
 
virtual void SetValue (vtkIdType idx, ValueType value)=0
 Set the data at a particular index. More...
 
virtual void GetTypedTuple (vtkIdType idx, ValueType *t) const =0
 Copy the tuple value into a user-provided array. More...
 
virtual vtkIdType InsertNextValue (ValueType v)=0
 Insert data at the end of the array. More...
 
virtual void InsertValue (vtkIdType idx, ValueType v)=0
 Insert data at a specified position in the array. More...
 
virtual ValueType GetTypedComponent (vtkIdType tupleIdx, int comp) const
 
virtual void SetTypedComponent (vtkIdType tupleIdx, int comp, ValueType v)
 
int GetArrayType () const override
 Method for type-checking in FastDownCast implementations. More...
 
vtkTypeBool Allocate (vtkIdType size, vtkIdType ext=1000) override=0
 Allocate memory for this array. More...
 
vtkTypeBool Resize (vtkIdType numTuples) override=0
 Resize the array to the requested number of tuples and preserve data. More...
 
- Public Member Functions inherited from vtkGenericDataArray< vtkTypedDataArray< Scalar >, Scalar >
 vtkTemplateTypeMacro (SelfType, vtkDataArray)
 
ValueType GetValue (vtkIdType valueIdx) const
 Get the value at valueIdx. More...
 
void SetValue (vtkIdType valueIdx, ValueType value)
 Set the value at valueIdx to value. More...
 
void GetTypedTuple (vtkIdType tupleIdx, ValueType *tuple) const
 Copy the tuple at tupleIdx into tuple. More...
 
void SetTypedTuple (vtkIdType tupleIdx, const ValueType *tuple)
 Set this array's tuple at tupleIdx to the values in tuple. More...
 
ValueType GetTypedComponent (vtkIdType tupleIdx, int compIdx) const
 Get component compIdx of the tuple at tupleIdx. More...
 
void SetTypedComponent (vtkIdType tupleIdx, int compIdx, ValueType value)
 Set component compIdx of the tuple at tupleIdx to value. More...
 
void * GetVoidPointer (vtkIdType valueIdx) override
 Default implementation raises a runtime error. More...
 
ValueTypeGetPointer (vtkIdType valueIdx)
 
void SetVoidArray (void *, vtkIdType, int) override
 
void SetVoidArray (void *, vtkIdType, int, int) 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...
 
void * WriteVoidPointer (vtkIdType valueIdx, vtkIdType numValues) override
 Get the address of a particular data index. More...
 
ValueTypeWritePointer (vtkIdType valueIdx, vtkIdType numValues)
 
void RemoveTuple (vtkIdType tupleIdx) override
 Removes a tuple at the given index. More...
 
vtkIdType InsertNextValue (ValueType value)
 Insert data at the end of the array. More...
 
void InsertValue (vtkIdType valueIdx, ValueType value)
 Insert data at a specified position in the array. More...
 
void InsertTypedTuple (vtkIdType tupleIdx, const ValueType *t)
 Insert (memory allocation performed) the tuple t at tupleIdx. More...
 
vtkIdType InsertNextTypedTuple (const ValueType *t)
 Insert (memory allocation performed) the tuple onto the end of the array. More...
 
void InsertTypedComponent (vtkIdType tupleIdx, int compIdx, ValueType val)
 Insert (memory allocation performed) the value at the specified tuple and component location. More...
 
void GetValueRange (ValueType range[2], int comp)
 Get the range of array values for the given component in the native data type. More...
 
ValueTypeGetValueRange (int comp)
 
ValueTypeGetValueRange ()
 Get the range of array values for the 0th component in the native data type. More...
 
void GetValueRange (ValueType range[2])
 
vtkIdType Capacity ()
 Return the capacity in typeof T units of the current array. More...
 
virtual void FillTypedComponent (int compIdx, ValueType value)
 Set component comp of all tuples to value. More...
 
virtual void FillValue (ValueType value)
 Set all the values in array to value. More...
 
int GetDataType () const override
 Return the underlying data type. More...
 
int GetDataTypeSize () const override
 Return the size of the underlying data type. More...
 
bool HasStandardMemoryLayout () const override
 Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g. More...
 
vtkTypeBool Allocate (vtkIdType size, vtkIdType ext=1000) override
 Allocate memory for this array. More...
 
vtkTypeBool Resize (vtkIdType numTuples) override
 Resize the array to the requested number of tuples and preserve data. More...
 
void SetNumberOfComponents (int num) override
 Set/Get the dimension (n) of the components. More...
 
void SetNumberOfTuples (vtkIdType number) override
 Set the number of tuples (a component group) in the array. More...
 
void Initialize () override
 Release storage and reset array to initial state. More...
 
void Squeeze () override
 Free any unnecessary memory. More...
 
void SetTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
 Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array. More...
 
void SetTuple (vtkIdType tupleIdx, const float *tuple) override
 Set the data tuple at tupleIdx. More...
 
void SetTuple (vtkIdType tupleIdx, const double *tuple) override
 
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...
 
void InsertTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
 Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx. More...
 
void InsertTuple (vtkIdType tupleIdx, const float *source) override
 Insert the data tuple at tupleIdx. More...
 
void InsertTuple (vtkIdType tupleIdx, const double *source) override
 
void InsertComponent (vtkIdType tupleIdx, int compIdx, double value) override
 Insert value at the location specified by tupleIdx and compIdx. More...
 
vtkIdType InsertNextTuple (vtkIdType srcTupleIdx, vtkAbstractArray *source) override
 Insert the tuple from srcTupleIdx in the source array at the end of this array. More...
 
vtkIdType InsertNextTuple (const float *tuple) override
 Insert the data tuple at the end of the array and return the tuple index at which the data was inserted. More...
 
vtkIdType InsertNextTuple (const double *tuple) override
 
void GetTuples (vtkIdList *tupleIds, vtkAbstractArray *output) override
 Given a list of tuple ids, return an array of tuples. More...
 
void GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override
 Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive). More...
 
double * GetTuple (vtkIdType tupleIdx) override
 Get the data tuple at tupleIdx. More...
 
void GetTuple (vtkIdType tupleIdx, double *tuple) override
 Get the data tuple at tupleIdx by filling in a user-provided array, Make sure that your array is large enough to hold the NumberOfComponents amount of data being returned. More...
 
void InterpolateTuple (vtkIdType dstTupleIdx, 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 dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray *source1, vtkIdType srcTupleIdx2, 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 SetComponent (vtkIdType tupleIdx, int compIdx, double value) override
 Set the data component at the location specified by tupleIdx and compIdx to value. More...
 
double GetComponent (vtkIdType tupleIdx, int compIdx) override
 Return the data component at the location specified by tupleIdx and compIdx. More...
 
void SetVariantValue (vtkIdType valueIdx, vtkVariant value) override
 Set a value in the array from a variant. More...
 
vtkVariant GetVariantValue (vtkIdType valueIdx) override
 Retrieve value from the array as a variant. More...
 
void InsertVariantValue (vtkIdType valueIdx, vtkVariant value) override
 Insert a value into the array from a variant. More...
 
vtkIdType LookupValue (vtkVariant value) override
 Return the value indices where a specific value appears. More...
 
void LookupValue (vtkVariant value, vtkIdList *valueIds) override
 
virtual vtkIdType LookupTypedValue (ValueType value)
 
virtual void LookupTypedValue (ValueType value, vtkIdList *valueIds)
 
void ClearLookup () override
 Delete the associated fast lookup data structure on this array, if it exists. More...
 
void DataChanged () override
 Tell the array explicitly that the data has changed. More...
 
void FillComponent (int compIdx, double value) override
 Fill a component of a data array with a specified value. More...
 
vtkArrayIteratorNewIterator () override
 Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate. More...
 
void GetFiniteValueRange (ValueType range[2], int comp)
 These methods are analogous to the GetValueRange methods, except that the only consider finite values. More...
 
ValueTypeGetFiniteValueRange (int comp)
 These methods are analogous to the GetValueRange methods, except that the only consider finite values. More...
 
ValueTypeGetFiniteValueRange ()
 These methods are analogous to the GetValueRange methods, except that the only consider finite values. More...
 
void GetFiniteValueRange (ValueType range[2])
 These methods are analogous to the GetValueRange methods, except that the only consider finite values. More...
 
- Public Member Functions inherited from vtkDataArray
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDataArrayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int IsNumeric () const override
 This method is here to make backward compatibility easier. More...
 
int GetElementComponentSize () const override
 Return the size, in bytes, of the lowest-level element of an array. More...
 
double GetTuple1 (vtkIdType tupleIdx)
 These methods are included as convenience for the wrappers. More...
 
double * GetTuple2 (vtkIdType tupleIdx)
 
double * GetTuple3 (vtkIdType tupleIdx)
 
double * GetTuple4 (vtkIdType tupleIdx)
 
double * GetTuple6 (vtkIdType tupleIdx)
 
double * GetTuple9 (vtkIdType tupleIdx)
 
void SetTuple1 (vtkIdType tupleIdx, double value)
 These methods are included as convenience for the wrappers. More...
 
void SetTuple2 (vtkIdType tupleIdx, double val0, double val1)
 
void SetTuple3 (vtkIdType tupleIdx, double val0, double val1, double val2)
 
void SetTuple4 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3)
 
void SetTuple6 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5)
 
void SetTuple9 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8)
 
void InsertTuple1 (vtkIdType tupleIdx, double value)
 These methods are included as convenience for the wrappers. More...
 
void InsertTuple2 (vtkIdType tupleIdx, double val0, double val1)
 
void InsertTuple3 (vtkIdType tupleIdx, double val0, double val1, double val2)
 
void InsertTuple4 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3)
 
void InsertTuple6 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5)
 
void InsertTuple9 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8)
 
void InsertNextTuple1 (double value)
 These methods are included as convenience for the wrappers. More...
 
void InsertNextTuple2 (double val0, double val1)
 
void InsertNextTuple3 (double val0, double val1, double val2)
 
void InsertNextTuple4 (double val0, double val1, double val2, double val3)
 
void InsertNextTuple6 (double val0, double val1, double val2, double val3, double val4, double val5)
 
void InsertNextTuple9 (double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8)
 
virtual void RemoveFirstTuple ()
 
virtual void RemoveLastTuple ()
 
virtual void GetData (vtkIdType tupleMin, vtkIdType tupleMax, int compMin, int compMax, vtkDoubleArray *data)
 Get the data as a double array in the range (tupleMin,tupleMax) and (compMin, compMax). More...
 
void DeepCopy (vtkAbstractArray *aa) override
 Deep copy of data. More...
 
virtual void DeepCopy (vtkDataArray *da)
 
virtual void ShallowCopy (vtkDataArray *other)
 Create a shallow copy of other into this, if possible. More...
 
virtual void Fill (double value)
 Fill all values of a data array with a specified value. More...
 
virtual void CopyComponent (int dstComponent, vtkDataArray *src, int srcComponent)
 Copy a component from one data array into a component on this data array. More...
 
unsigned long GetActualMemorySize () const override
 Return the memory in kibibytes (1024 bytes) consumed by this data array. More...
 
void CreateDefaultLookupTable ()
 Create default lookup table. More...
 
void SetLookupTable (vtkLookupTable *lut)
 Set/get the lookup table associated with this scalar data, if any. More...
 
virtual vtkLookupTableGetLookupTable ()
 
void GetRange (double range[2], int comp)
 The range of the data array values for the given component will be returned in the provided range array argument. More...
 
double * GetRange (int comp)
 Return the range of the data array values for the given component. More...
 
double * GetRange ()
 Return the range of the data array. More...
 
void GetRange (double range[2])
 The range of the data array values will be returned in the provided range array argument. More...
 
void GetFiniteRange (double range[2], int comp)
 The range of the data array values for the given component will be returned in the provided range array argument. More...
 
double * GetFiniteRange (int comp)
 Return the range of the data array values for the given component. More...
 
double * GetFiniteRange ()
 Return the range of the data array. More...
 
void GetFiniteRange (double range[2])
 The range of the data array values will be returned in the provided range array argument. More...
 
void GetDataTypeRange (double range[2])
 These methods return the Min and Max possible range of the native data type. More...
 
double GetDataTypeMin ()
 
double GetDataTypeMax ()
 
virtual double GetMaxNorm ()
 Return the maximum norm for the tuples. More...
 
void Modified () override
 Removes out-of-date L2_NORM_RANGE() and L2_NORM_FINITE_RANGE() values. More...
 
int CopyInformation (vtkInformation *infoFrom, int deep=1) override
 Copy information instance. More...
 
- Public Member Functions inherited from vtkAbstractArray
vtkAbstractArrayNewInstance () const
 
int GetNumberOfComponents () const
 
void SetComponentName (vtkIdType component, const char *name)
 Set the name for a component. More...
 
const char * GetComponentName (vtkIdType component) const
 Get the component name for a given component. More...
 
bool HasAComponentName () const
 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 () const
 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...
 
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) const
 Get the name of a data type as a string. More...
 
virtual vtkIdType GetDataSize () const
 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 () const
 Inquire if this array has an instance of vtkInformation already associated with it. 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)
 
- 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...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypedDataArray< Scalar > * FastDownCast (vtkAbstractArray *source)
 Perform a fast, safe cast from a vtkAbstractArray to a vtkTypedDataArray. More...
 
- Static Public Member Functions inherited from vtkDataArray
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataArraySafeDownCast (vtkObjectBase *o)
 
static vtkDataArrayFastDownCast (vtkAbstractArray *source)
 Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArray. More...
 
static void GetDataTypeRange (int type, double range[2])
 
static double GetDataTypeMin (int type)
 
static double GetDataTypeMax (int type)
 
static vtkDataArrayCreateDataArray (int dataType)
 Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_SIGNED_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. More...
 
static vtkInformationDoubleVectorKeyCOMPONENT_RANGE ()
 This key is used to hold tight bounds on the range of one component over all tuples of the array. More...
 
static vtkInformationDoubleVectorKeyL2_NORM_RANGE ()
 This key is used to hold tight bounds on the $L_2$ norm of tuples in the array. More...
 
static vtkInformationDoubleVectorKeyL2_NORM_FINITE_RANGE ()
 This key is used to hold tight bounds on the $L_2$ norm of tuples in the array. More...
 
static vtkInformationStringKeyUNITS_LABEL ()
 A human-readable string indicating the units for the array data. More...
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

 vtkTypedDataArray ()
 
 ~vtkTypedDataArray () override
 
virtual bool AllocateTuples (vtkIdType numTuples)
 Needed for vtkGenericDataArray API, but just aborts. More...
 
virtual bool ReallocateTuples (vtkIdType numTuples)
 Needed for vtkGenericDataArray API, but just aborts. More...
 
- Protected Member Functions inherited from vtkGenericDataArray< vtkTypedDataArray< Scalar >, Scalar >
 vtkGenericDataArray ()
 
 ~vtkGenericDataArray () override
 
bool AllocateTuples (vtkIdType numTuples)
 Allocate space for numTuples. More...
 
bool ReallocateTuples (vtkIdType numTuples)
 Allocate space for numTuples. More...
 
bool EnsureAccessToTuple (vtkIdType tupleIdx)
 
void ComputeValueRange (ValueType range[2], int comp)
 Compute the range for a specific component. More...
 
void ComputeFiniteValueRange (ValueType range[2], int comp)
 Compute the range for a specific component. More...
 
bool ComputeScalarValueRange (ValueType *ranges)
 Computes the range for each component of an array, the length of ranges must be two times the number of components. More...
 
bool ComputeVectorValueRange (ValueType range[2])
 Returns true if the range was computed. More...
 
bool ComputeFiniteScalarValueRange (ValueType *ranges)
 Computes the range for each component of an array, the length of ranges must be two times the number of components. More...
 
bool ComputeFiniteVectorValueRange (ValueType range[2])
 Returns true if the range was computed. More...
 
- Protected Member Functions inherited from vtkDataArray
virtual vtkObjectBaseNewInstanceInternal () const
 
virtual void ComputeRange (double range[2], int comp)
 Compute the range for a specific component. More...
 
virtual void ComputeFiniteRange (double range[2], int comp)
 Compute the range for a specific component. More...
 
virtual bool ComputeScalarRange (double *ranges)
 Computes the range for each component of an array, the length of ranges must be two times the number of components. More...
 
virtual bool ComputeVectorRange (double range[2])
 Returns true if the range was computed. More...
 
virtual bool ComputeFiniteScalarRange (double *ranges)
 Computes the range for each component of an array, the length of ranges must be two times the number of components. More...
 
virtual bool ComputeFiniteVectorRange (double range[2])
 Returns true if the range was computed. More...
 
 vtkDataArray ()
 
 ~vtkDataArray () 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Friends

class vtkGenericDataArray< vtkTypedDataArray< Scalar >, Scalar >
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkGenericDataArray< vtkTypedDataArray< Scalar >, Scalar >
std::vector< double > LegacyTuple
 
std::vector< ValueTypeLegacyValueRange
 
std::vector< ValueTypeLegacyValueRangeFull
 
vtkGenericDataArrayLookupHelper< SelfTypeLookup
 
- Protected Attributes inherited from vtkDataArray
vtkLookupTableLookupTable
 
double Range [2]
 
double FiniteRange [2]
 
- 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

template<class Scalar>
class vtkTypedDataArray< Scalar >

Extend vtkDataArray with abstract type-specific API.

This templated class decorates vtkDataArray with additional type-specific methods that can be used to interact with the data.

NOTE: This class has been made obsolete by the newer vtkGenericDataArray.

Warning
This class uses vtkTypeTraits to implement GetDataType(). Since vtkIdType is a typedef for either a 32- or 64-bit integer, subclasses that are designed to hold vtkIdTypes will, by default, return an incorrect value from GetDataType(). To fix this, such subclasses should override GetDataType() to return VTK_ID_TYPE.
See also
vtkGenericDataArray

Definition at line 48 of file vtkTypedDataArray.h.

Member Typedef Documentation

◆ ValueType

template<class Scalar>
typedef Superclass::ValueType vtkTypedDataArray< Scalar >::ValueType

Definition at line 54 of file vtkTypedDataArray.h.

◆ Iterator

template<class Scalar>
typedef vtkTypedDataArrayIterator<ValueType> vtkTypedDataArray< Scalar >::Iterator

Typedef to a suitable iterator class.

Definition at line 59 of file vtkTypedDataArray.h.

Member Enumeration Documentation

◆ anonymous enum

template<class Scalar>
anonymous enum

Compile time access to the VTK type identifier.

Enumerator
VTK_DATA_TYPE 

Definition at line 74 of file vtkTypedDataArray.h.

Constructor & Destructor Documentation

◆ vtkTypedDataArray()

template<class Scalar>
vtkTypedDataArray< Scalar >::vtkTypedDataArray ( )
protected

◆ ~vtkTypedDataArray()

template<class Scalar>
vtkTypedDataArray< Scalar >::~vtkTypedDataArray ( )
overrideprotected

Member Function Documentation

◆ vtkTemplateTypeMacro()

template<class Scalar>
vtkTypedDataArray< Scalar >::vtkTemplateTypeMacro ( vtkTypedDataArray< Scalar >  ,
GenericDataArrayType   
)

◆ Begin()

template<class Scalar >
vtkTypedDataArray< Scalar >::Iterator vtkTypedDataArray< Scalar >::Begin ( )
inline

Return an iterator initialized to the first element of the data.

Definition at line 190 of file vtkTypedDataArray.h.

◆ End()

template<class Scalar >
vtkTypedDataArray< Scalar >::Iterator vtkTypedDataArray< Scalar >::End ( )
inline

Return an iterator initialized to first element past the end of the data.

Definition at line 196 of file vtkTypedDataArray.h.

◆ FastDownCast()

template<class Scalar>
static vtkTypedDataArray<Scalar>* vtkTypedDataArray< Scalar >::FastDownCast ( vtkAbstractArray source)
static

Perform a fast, safe cast from a vtkAbstractArray to a vtkTypedDataArray.

This method checks if:

  • source->GetArrayType() is appropriate, and
  • source->GetDataType() matches the Scalar template argument if these conditions are met, the method performs a static_cast to return source as a vtkTypedDataArray pointer. Otherwise, nullptr is returned.

◆ GetDataType()

template<class Scalar>
int vtkTypedDataArray< Scalar >::GetDataType ( ) const
overridevirtual

Return the VTK data type held by this array.

Implements vtkAbstractArray.

◆ GetDataTypeSize()

template<class Scalar>
int vtkTypedDataArray< Scalar >::GetDataTypeSize ( ) const
overridevirtual

Return the size of the element type in bytes.

Implements vtkAbstractArray.

◆ SetTypedTuple()

template<class Scalar>
virtual void vtkTypedDataArray< Scalar >::SetTypedTuple ( vtkIdType  i,
const ValueType t 
)
pure virtual

Set the tuple value at the ith location in the array.

◆ InsertTypedTuple()

template<class Scalar>
virtual void vtkTypedDataArray< Scalar >::InsertTypedTuple ( vtkIdType  i,
const ValueType t 
)
pure virtual

Insert (memory allocation performed) the tuple into the ith location in the array.

◆ InsertNextTypedTuple()

template<class Scalar>
virtual vtkIdType vtkTypedDataArray< Scalar >::InsertNextTypedTuple ( const ValueType t)
pure virtual

Insert (memory allocation performed) the tuple onto the end of the array.

◆ GetValue()

template<class Scalar>
virtual ValueType vtkTypedDataArray< Scalar >::GetValue ( vtkIdType  idx) const
pure virtual

Get the data at a particular index.

Implemented in vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

◆ GetValueReference()

template<class Scalar>
virtual ValueType& vtkTypedDataArray< Scalar >::GetValueReference ( vtkIdType  idx)
pure virtual

Get a reference to the scalar value at a particular index.

Implemented in vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

◆ SetValue()

template<class Scalar>
virtual void vtkTypedDataArray< Scalar >::SetValue ( vtkIdType  idx,
ValueType  value 
)
pure virtual

Set the data at a particular index.

Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.

◆ GetTypedTuple()

template<class Scalar>
virtual void vtkTypedDataArray< Scalar >::GetTypedTuple ( vtkIdType  idx,
ValueType t 
) const
pure virtual

Copy the tuple value into a user-provided array.

◆ InsertNextValue()

template<class Scalar>
virtual vtkIdType vtkTypedDataArray< Scalar >::InsertNextValue ( ValueType  v)
pure virtual

Insert data at the end of the array.

Return its location in the array.

◆ InsertValue()

template<class Scalar>
virtual void vtkTypedDataArray< Scalar >::InsertValue ( vtkIdType  idx,
ValueType  v 
)
pure virtual

Insert data at a specified position in the array.

◆ GetTypedComponent()

template<class Scalar>
virtual ValueType vtkTypedDataArray< Scalar >::GetTypedComponent ( vtkIdType  tupleIdx,
int  comp 
) const
virtual

◆ SetTypedComponent()

template<class Scalar>
virtual void vtkTypedDataArray< Scalar >::SetTypedComponent ( vtkIdType  tupleIdx,
int  comp,
ValueType  v 
)
virtual

◆ GetArrayType()

template<class Scalar>
int vtkTypedDataArray< Scalar >::GetArrayType ( ) const
inlineoverridevirtual

Method for type-checking in FastDownCast implementations.

Reimplemented from vtkDataArray.

Definition at line 152 of file vtkTypedDataArray.h.

◆ Allocate()

template<class Scalar>
vtkTypeBool vtkTypedDataArray< Scalar >::Allocate ( vtkIdType  numValues,
vtkIdType  ext = 1000 
)
overridepure virtual

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.

Implemented in vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

◆ Resize()

template<class Scalar>
vtkTypeBool vtkTypedDataArray< Scalar >::Resize ( vtkIdType  numTuples)
overridepure virtual

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.

Implemented in vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

◆ AllocateTuples()

template<class Scalar>
virtual bool vtkTypedDataArray< Scalar >::AllocateTuples ( vtkIdType  numTuples)
protectedvirtual

Needed for vtkGenericDataArray API, but just aborts.

Override Allocate instead.

◆ ReallocateTuples()

template<class Scalar>
virtual bool vtkTypedDataArray< Scalar >::ReallocateTuples ( vtkIdType  numTuples)
protectedvirtual

Needed for vtkGenericDataArray API, but just aborts.

Override Resize instead.

Friends And Related Function Documentation

◆ vtkGenericDataArray< vtkTypedDataArray< Scalar >, Scalar >

template<class Scalar>
friend class vtkGenericDataArray< vtkTypedDataArray< Scalar >, Scalar >
friend

Definition at line 180 of file vtkTypedDataArray.h.


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