Implementation template for vtkDataArray. More...
#include <vtkDataArrayTemplate.h>
Detailed Description
template<class T>
class vtkDataArrayTemplate< T >
Implementation template for vtkDataArray.
There is a vtkDataArray subclass for each native type supported by VTK. This template is used to implement all the subclasses in the same way while avoiding code duplication.
Definition at line 35 of file vtkDataArrayTemplate.h.
Member Typedef Documentation
| typedef vtkTypedDataArray<T> vtkDataArrayTemplate< T >::Superclass |
Reimplemented from vtkTypeTemplate< vtkDataArrayTemplate< T >, vtkTypedDataArray< T > >.
Definition at line 39 of file vtkDataArrayTemplate.h.
| typedef Superclass::ValueType vtkDataArrayTemplate< T >::ValueType |
Typedef to get the type of value stored in the array.
Reimplemented from vtkTypedDataArray< T >.
Definition at line 40 of file vtkDataArrayTemplate.h.
| typedef ValueType* vtkDataArrayTemplate< T >::Iterator |
Typedef to a suitable iterator class. Rather than using this member directly, consider using vtkDataArrayIteratorMacro for safety and efficiency.
Reimplemented from vtkTypedDataArray< T >.
Definition at line 46 of file vtkDataArrayTemplate.h.
Member Enumeration Documentation
| enum vtkDataArrayTemplate::DeleteMethod |
Definition at line 249 of file vtkDataArrayTemplate.h.
Constructor & Destructor Documentation
| vtkDataArrayTemplate< T >::vtkDataArrayTemplate | ( | ) | [protected] |
| vtkDataArrayTemplate< T >::~vtkDataArrayTemplate | ( | ) | [protected] |
Member Function Documentation
| void vtkDataArrayTemplate< T >::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
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 vtkDataArray.
| Iterator vtkDataArrayTemplate< T >::Begin | ( | ) | [inline] |
Return an iterator initialized to the first element of the data. Rather than using this member directly, consider using vtkDataArrayIteratorMacro for safety and efficiency.
Reimplemented from vtkTypedDataArray< T >.
Definition at line 51 of file vtkDataArrayTemplate.h.
| Iterator vtkDataArrayTemplate< T >::End | ( | ) | [inline] |
Return an iterator initialized to first element past the end of the data. Rather than using this member directly, consider using vtkDataArrayIteratorMacro for safety and efficiency.
Reimplemented from vtkTypedDataArray< T >.
Definition at line 56 of file vtkDataArrayTemplate.h.
| static vtkDataArrayTemplate<T>* vtkDataArrayTemplate< T >::FastDownCast | ( | vtkAbstractArray * | src | ) | [static] |
Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArrayTemplate. This method checks if: - source->GetArrayType() is appropriate, and - source->GetDataType() matches vtkTypeTraits<ValueType>::VTK_TYPE_ID if these conditions are met, the method performs a static_cast to return source as a vtkTypedDataArray pointer. Otherwise, NULL is returned.
Reimplemented from vtkTypedDataArray< T >.
| int vtkDataArrayTemplate< T >::Allocate | ( | vtkIdType | sz, |
| vtkIdType | ext = 1000 |
||
| ) | [virtual] |
Allocate memory for this array. Delete old storage only if necessary. Note that ext is no longer used.
Implements vtkAbstractArray.
| void vtkDataArrayTemplate< T >::Initialize | ( | ) | [virtual] |
Release storage and reset array to initial state.
Implements vtkAbstractArray.
| int vtkDataArrayTemplate< T >::GetDataTypeSize | ( | ) | [inline, virtual] |
Return the size of the data type.
Reimplemented from vtkTypedDataArray< T >.
Definition at line 74 of file vtkDataArrayTemplate.h.
| void vtkDataArrayTemplate< T >::SetNumberOfTuples | ( | vtkIdType | number | ) | [virtual] |
Set the number of n-tuples in the array.
Implements vtkAbstractArray.
| virtual void vtkDataArrayTemplate< T >::SetTuple | ( | vtkIdType | i, |
| vtkIdType | j, | ||
| vtkAbstractArray * | source | ||
| ) | [virtual] |
Set the tuple at the ith location using the jth tuple 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 vtkDataArray.
| virtual void vtkDataArrayTemplate< T >::InsertTuple | ( | vtkIdType | i, |
| vtkIdType | j, | ||
| vtkAbstractArray * | source | ||
| ) | [virtual] |
Insert the jth tuple in the source array, at ith location in this array. Note that memory allocation is performed as necessary to hold the data.
Implements vtkDataArray.
| virtual void vtkDataArrayTemplate< T >::InsertTuples | ( | vtkIdList * | destIds, |
| vtkIdList * | srcIds, | ||
| vtkAbstractArray * | source | ||
| ) | [virtual] |
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.
| virtual vtkIdType vtkDataArrayTemplate< T >::InsertNextTuple | ( | vtkIdType | j, |
| vtkAbstractArray * | source | ||
| ) | [virtual] |
Insert the jth tuple in the source array, at the end in this array. Note that memory allocation is performed as necessary to hold the data. Returns the location at which the data was inserted.
Implements vtkDataArray.
| double* vtkDataArrayTemplate< T >::GetTuple | ( | vtkIdType | i | ) | [virtual] |
Get a pointer to a tuple at the ith location. This is a dangerous method (it is not thread safe since a pointer is returned).
Implements vtkDataArray.
| void vtkDataArrayTemplate< T >::GetTuple | ( | vtkIdType | i, |
| double * | tuple | ||
| ) | [virtual] |
Copy the tuple value into a user-provided array.
Implements vtkDataArray.
| void vtkDataArrayTemplate< T >::GetTupleValue | ( | vtkIdType | i, |
| T * | tuple | ||
| ) | [virtual] |
Copy the tuple value into a user-provided array.
Implements vtkTypedDataArray< T >.
| void vtkDataArrayTemplate< T >::SetTuple | ( | vtkIdType | i, |
| const float * | tuple | ||
| ) | [virtual] |
Set the tuple value at the ith location in the array.
Implements vtkDataArray.
| void vtkDataArrayTemplate< T >::SetTuple | ( | vtkIdType | i, |
| const double * | tuple | ||
| ) | [virtual] |
Set the tuple value at the ith location in the array.
Implements vtkDataArray.
| void vtkDataArrayTemplate< T >::SetTupleValue | ( | vtkIdType | i, |
| const T * | tuple | ||
| ) | [virtual] |
Set the tuple value at the ith location in the array.
Implements vtkTypedDataArray< T >.
| void vtkDataArrayTemplate< T >::InsertTuple | ( | vtkIdType | i, |
| const float * | tuple | ||
| ) | [virtual] |
Insert (memory allocation performed) the tuple into the ith location in the array.
Implements vtkDataArray.
| void vtkDataArrayTemplate< T >::InsertTuple | ( | vtkIdType | i, |
| const double * | tuple | ||
| ) | [virtual] |
Insert (memory allocation performed) the tuple into the ith location in the array.
Implements vtkDataArray.
| void vtkDataArrayTemplate< T >::InsertTupleValue | ( | vtkIdType | i, |
| const T * | tuple | ||
| ) | [virtual] |
Insert (memory allocation performed) the tuple into the ith location in the array.
Implements vtkTypedDataArray< T >.
| vtkIdType vtkDataArrayTemplate< T >::InsertNextTuple | ( | const float * | tuple | ) | [virtual] |
Insert (memory allocation performed) the tuple onto the end of the array.
Implements vtkDataArray.
| vtkIdType vtkDataArrayTemplate< T >::InsertNextTuple | ( | const double * | tuple | ) | [virtual] |
Insert (memory allocation performed) the tuple onto the end of the array.
Implements vtkDataArray.
| vtkIdType vtkDataArrayTemplate< T >::InsertNextTupleValue | ( | const T * | tuple | ) | [virtual] |
Insert (memory allocation performed) the tuple onto the end of the array.
Implements vtkTypedDataArray< T >.
| void vtkDataArrayTemplate< T >::GetValueRange | ( | T | range[2], |
| int | comp | ||
| ) | [inline] |
Get the range of array values for the given component in the native data type.
Definition at line 140 of file vtkDataArrayTemplate.h.
| T* vtkDataArrayTemplate< T >::GetValueRange | ( | int | comp | ) | [inline] |
Get the range of array values for the given component in the native data type.
Definition at line 147 of file vtkDataArrayTemplate.h.
| T* vtkDataArrayTemplate< T >::GetValueRange | ( | ) | [inline] |
Get the range of array values for the 0th component in the native data type.
Definition at line 157 of file vtkDataArrayTemplate.h.
| void vtkDataArrayTemplate< T >::GetValueRange | ( | T | range[2] | ) | [inline] |
Get the range of array values for the 0th component in the native data type.
Definition at line 159 of file vtkDataArrayTemplate.h.
| void vtkDataArrayTemplate< T >::Squeeze | ( | ) | [inline, virtual] |
Resize object to just fit data requirement. Reclaims extra memory.
Implements vtkAbstractArray.
Definition at line 164 of file vtkDataArrayTemplate.h.
| vtkIdType vtkDataArrayTemplate< T >::Capacity | ( | ) | [inline] |
Return the capacity in typeof T units of the current array.
Definition at line 167 of file vtkDataArrayTemplate.h.
| virtual int vtkDataArrayTemplate< T >::Resize | ( | vtkIdType | numTuples | ) | [virtual] |
Resize the array while conserving the data. Caution: No assumption can be made on the resulting size of the DataArray, meaning that the provided argument won't necessary be equal to the data array size, but at least the size will be bigger.
Implements vtkAbstractArray.
| T vtkDataArrayTemplate< T >::GetValue | ( | vtkIdType | id | ) | [inline, virtual] |
Get the data at a particular index.
Implements vtkTypedDataArray< T >.
Definition at line 177 of file vtkDataArrayTemplate.h.
| T& vtkDataArrayTemplate< T >::GetValueReference | ( | vtkIdType | id | ) | [inline, virtual] |
Get the data at a particular index.
Implements vtkTypedDataArray< T >.
Definition at line 179 of file vtkDataArrayTemplate.h.
| void vtkDataArrayTemplate< T >::SetValue | ( | vtkIdType | id, |
| T | value | ||
| ) | [inline, virtual] |
Set the data at a particular index. Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.
Implements vtkTypedDataArray< T >.
Definition at line 186 of file vtkDataArrayTemplate.h.
| void vtkDataArrayTemplate< T >::SetNumberOfValues | ( | vtkIdType | number | ) | [virtual] |
Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for fast insertion.
Reimplemented from vtkTypedDataArray< T >.
| void vtkDataArrayTemplate< T >::InsertValue | ( | vtkIdType | id, |
| T | f | ||
| ) | [virtual] |
Insert data at a specified position in the array.
Implements vtkTypedDataArray< T >.
| void vtkDataArrayTemplate< T >::SetVariantValue | ( | vtkIdType | id, |
| vtkVariant | value | ||
| ) | [virtual] |
Set a value in the array from a vtkVariant.
Implements vtkAbstractArray.
| vtkIdType vtkDataArrayTemplate< T >::InsertNextValue | ( | T | f | ) | [virtual] |
Insert data at the end of the array. Return its location in the array.
Implements vtkTypedDataArray< T >.
| virtual void vtkDataArrayTemplate< T >::RemoveTuple | ( | vtkIdType | id | ) | [virtual] |
These methods remove tuples from the data array. They shift data and resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.
Implements vtkDataArray.
| virtual void vtkDataArrayTemplate< T >::RemoveFirstTuple | ( | ) | [virtual] |
These methods remove tuples from the data array. They shift data and resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.
Implements vtkDataArray.
| virtual void vtkDataArrayTemplate< T >::RemoveLastTuple | ( | ) | [virtual] |
These methods remove tuples from the data array. They shift data and resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.
Implements vtkDataArray.
| double vtkDataArrayTemplate< T >::GetComponent | ( | vtkIdType | i, |
| int | j | ||
| ) | [virtual] |
Return the data component at the ith tuple and jth component location. Note that i is less then NumberOfTuples and j is less then NumberOfComponents.
Reimplemented from vtkDataArray.
| void vtkDataArrayTemplate< T >::SetComponent | ( | vtkIdType | i, |
| int | j, | ||
| double | c | ||
| ) | [virtual] |
Set the data component at the ith tuple and jth component location. Note that i is less then NumberOfTuples and j is less then NumberOfComponents. Make sure enough memory has been allocated (use SetNumberOfTuples() and SetNumberOfComponents()).
Reimplemented from vtkDataArray.
| virtual void vtkDataArrayTemplate< T >::InsertComponent | ( | vtkIdType | i, |
| int | j, | ||
| double | c | ||
| ) | [virtual] |
Insert the data component at ith tuple and jth component location. Note that memory allocation is performed as necessary to hold the data.
Reimplemented from vtkDataArray.
| T* vtkDataArrayTemplate< T >::WritePointer | ( | vtkIdType | id, |
| vtkIdType | number | ||
| ) |
Get the address of a particular data index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.
| virtual void* vtkDataArrayTemplate< T >::WriteVoidPointer | ( | vtkIdType | id, |
| vtkIdType | number | ||
| ) | [inline, virtual] |
Get the address of a particular data index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.
Implements vtkDataArray.
Definition at line 235 of file vtkDataArrayTemplate.h.
| T* vtkDataArrayTemplate< T >::GetPointer | ( | vtkIdType | id | ) | [inline] |
Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc. If the data is simply being iterated over, consider using vtkDataArrayIteratorMacro for safety and efficiency, rather than using this member directly.
Definition at line 244 of file vtkDataArrayTemplate.h.
| virtual void* vtkDataArrayTemplate< T >::GetVoidPointer | ( | vtkIdType | id | ) | [inline, virtual] |
Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc. If the data is simply being iterated over, consider using vtkDataArrayIteratorMacro for safety and efficiency, rather than using this member directly.
Implements vtkAbstractArray.
Definition at line 245 of file vtkDataArrayTemplate.h.
| void vtkDataArrayTemplate< T >::SetArray | ( | T * | array, |
| vtkIdType | size, | ||
| int | save, | ||
| int | deleteMethod | ||
| ) |
This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array. If specified, the delete method determines how the data array will be deallocated. If the delete method is VTK_DATA_ARRAY_FREE, free() will be used. If the delete method is DELETE, delete[] will be used. The default is FREE.
| void vtkDataArrayTemplate< T >::SetArray | ( | T * | array, |
| vtkIdType | size, | ||
| int | save | ||
| ) | [inline] |
This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array. If specified, the delete method determines how the data array will be deallocated. If the delete method is VTK_DATA_ARRAY_FREE, free() will be used. If the delete method is DELETE, delete[] will be used. The default is FREE.
Definition at line 267 of file vtkDataArrayTemplate.h.
| virtual void vtkDataArrayTemplate< T >::SetVoidArray | ( | void * | array, |
| vtkIdType | size, | ||
| int | save | ||
| ) | [inline, virtual] |
This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array. If specified, the delete method determines how the data array will be deallocated. If the delete method is VTK_DATA_ARRAY_FREE, free() will be used. If the delete method is DELETE, delete[] will be used. The default is FREE.
Definition at line 269 of file vtkDataArrayTemplate.h.
| virtual void vtkDataArrayTemplate< T >::SetVoidArray | ( | void * | array, |
| vtkIdType | size, | ||
| int | save, | ||
| int | deleteMethod | ||
| ) | [inline, virtual] |
This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array. If specified, the delete method determines how the data array will be deallocated. If the delete method is VTK_DATA_ARRAY_FREE, free() will be used. If the delete method is DELETE, delete[] will be used. The default is FREE.
Definition at line 271 of file vtkDataArrayTemplate.h.
| virtual void vtkDataArrayTemplate< T >::ExportToVoidPointer | ( | void * | out_ptr | ) | [virtual] |
This method copies the array data to the void pointer specified by the user. It is up to the user to allocate enough memory for the void pointer.
| virtual vtkArrayIterator* vtkDataArrayTemplate< T >::NewIterator | ( | ) | [virtual] |
Returns a vtkArrayIteratorTemplate<T>.
Implements vtkAbstractArray.
| virtual vtkIdType vtkDataArrayTemplate< T >::LookupValue | ( | vtkVariant | value | ) | [virtual] |
Return the indices where a specific value appears.
Implements vtkAbstractArray.
| virtual void vtkDataArrayTemplate< T >::LookupValue | ( | vtkVariant | value, |
| vtkIdList * | ids | ||
| ) | [virtual] |
Return the indices where a specific value appears.
Implements vtkAbstractArray.
| vtkIdType vtkDataArrayTemplate< T >::LookupValue | ( | T | value | ) |
Return the indices where a specific value appears.
| void vtkDataArrayTemplate< T >::LookupValue | ( | T | value, |
| vtkIdList * | ids | ||
| ) |
Return the indices where a specific value appears.
| vtkIdType vtkDataArrayTemplate< T >::LookupTypedValue | ( | T | value | ) | [inline, virtual] |
Return the indices where a specific value appears.
Implements vtkTypedDataArray< T >.
Definition at line 294 of file vtkDataArrayTemplate.h.
| void vtkDataArrayTemplate< T >::LookupTypedValue | ( | T | value, |
| vtkIdList * | ids | ||
| ) | [inline, virtual] |
Return the indices where a specific value appears.
Implements vtkTypedDataArray< T >.
Definition at line 296 of file vtkDataArrayTemplate.h.
| virtual void vtkDataArrayTemplate< T >::DataChanged | ( | ) | [virtual] |
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.
| virtual void vtkDataArrayTemplate< T >::DataElementChanged | ( | vtkIdType | id | ) | [virtual] |
Tell the array explicitly that a single data element has changed. Like DataChanged(), then is only necessary when you modify the array contents without using the array's API.
| virtual void vtkDataArrayTemplate< T >::ClearLookup | ( | ) | [virtual] |
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.
| virtual int vtkDataArrayTemplate< T >::GetArrayType | ( | ) | [inline, virtual] |
Method for type-checking in FastDownCast implementations.
Reimplemented from vtkTypedDataArray< T >.
Definition at line 319 of file vtkDataArrayTemplate.h.
| T* vtkDataArrayTemplate< T >::ResizeAndExtend | ( | vtkIdType | sz | ) | [protected] |
| T* vtkDataArrayTemplate< T >::Realloc | ( | vtkIdType | sz | ) | [protected] |
| virtual void vtkDataArrayTemplate< T >::ComputeScalarRange | ( | double | range[2], |
| int | comp | ||
| ) | [protected, virtual] |
Slow range computation methods. Reimplement.
Reimplemented from vtkDataArray.
| virtual void vtkDataArrayTemplate< T >::ComputeVectorRange | ( | double | range[2] | ) | [protected, virtual] |
Slow range computation methods. Reimplement.
Reimplemented from vtkDataArray.
Member Data Documentation
T* vtkDataArrayTemplate< T >::Array [protected] |
Definition at line 325 of file vtkDataArrayTemplate.h.
T vtkDataArrayTemplate< T >::ValueRange[2] [protected] |
Definition at line 326 of file vtkDataArrayTemplate.h.
int vtkDataArrayTemplate< T >::TupleSize [protected] |
Definition at line 330 of file vtkDataArrayTemplate.h.
double* vtkDataArrayTemplate< T >::Tuple [protected] |
Definition at line 331 of file vtkDataArrayTemplate.h.
int vtkDataArrayTemplate< T >::SaveUserArray [protected] |
Definition at line 333 of file vtkDataArrayTemplate.h.
int vtkDataArrayTemplate< T >::DeleteMethod [protected] |
Definition at line 334 of file vtkDataArrayTemplate.h.
The documentation for this class was generated from the following file:
- dox/Common/Core/vtkDataArrayTemplate.h
