vtkArrayIteratorTemplate< T > Class Template Reference
#include <vtkArrayIteratorTemplate.h>
Detailed Description
template<class T>
class vtkArrayIteratorTemplate< T >
Implementation template for a array iterator.
This is implementation template for a array iterator. It only works with arrays that have a contiguous internal storage of values (as in vtkDataArray, vtkStringArray).
Definition at line 32 of file vtkArrayIteratorTemplate.h.
Public Types | |
| typedef vtkArrayIterator | Superclass |
| typedef T | ValueType |
Public Member Functions | |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | Initialize (vtkAbstractArray *array) |
| vtkAbstractArray * | GetArray () |
| T * | GetTuple (vtkIdType id) |
| vtkIdType | GetNumberOfTuples () |
| vtkIdType | GetNumberOfValues () |
| int | GetNumberOfComponents () |
| int | GetDataType () |
| int | GetDataTypeSize () |
| T & | GetValue (vtkIdType id) |
| void | SetValue (vtkIdType id, T value) |
Static Public Member Functions | |
| static vtkArrayIteratorTemplate< T > * | New () |
Protected Member Functions | |
| void | CollectRevisions (ostream &os) |
| vtkArrayIteratorTemplate () | |
| ~vtkArrayIteratorTemplate () | |
Protected Attributes | |
| T * | Pointer |
Member Typedef Documentation
| typedef vtkArrayIterator vtkArrayIteratorTemplate< T >::Superclass |
| typedef T vtkArrayIteratorTemplate< T >::ValueType |
This is the data type for the value.
Definition at line 91 of file vtkArrayIteratorTemplate.h.
Constructor & Destructor Documentation
| vtkArrayIteratorTemplate< T >::vtkArrayIteratorTemplate | ( | ) | [protected] |
| vtkArrayIteratorTemplate< T >::~vtkArrayIteratorTemplate | ( | ) | [protected] |
Member Function Documentation
| static vtkArrayIteratorTemplate<T>* vtkArrayIteratorTemplate< T >::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
| void vtkArrayIteratorTemplate< T >::CollectRevisions | ( | ostream & | os | ) | [protected, virtual] |
Reimplemented from vtkObjectBase.
| void vtkArrayIteratorTemplate< 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 vtkArrayIterator.
| virtual void vtkArrayIteratorTemplate< T >::Initialize | ( | vtkAbstractArray * | array | ) | [virtual] |
Set the array this iterator will iterate over. After Initialize() has been called, the iterator is valid so long as the Array has not been modified (except using the iterator itself). If the array is modified, the iterator must be re-intialized.
Implements vtkArrayIterator.
| vtkAbstractArray* vtkArrayIteratorTemplate< T >::GetArray | ( | ) | [inline] |
Get the array.
Definition at line 53 of file vtkArrayIteratorTemplate.h.
| T* vtkArrayIteratorTemplate< T >::GetTuple | ( | vtkIdType | id | ) |
Must be called only after Initialize.
| T& vtkArrayIteratorTemplate< T >::GetValue | ( | vtkIdType | id | ) | [inline] |
Must be called only after Initialize.
Definition at line 61 of file vtkArrayIteratorTemplate.h.
| void vtkArrayIteratorTemplate< T >::SetValue | ( | vtkIdType | id, | |
| T | value | |||
| ) | [inline] |
Sets the value at the index. This does not verify if the index is valid. The caller must ensure that id is less than the maximum number of values.
Definition at line 69 of file vtkArrayIteratorTemplate.h.
| vtkIdType vtkArrayIteratorTemplate< T >::GetNumberOfTuples | ( | ) |
Must be called only after Initialize.
| vtkIdType vtkArrayIteratorTemplate< T >::GetNumberOfValues | ( | ) |
Must be called only after Initialize.
| int vtkArrayIteratorTemplate< T >::GetNumberOfComponents | ( | ) |
Must be called only after Initialize.
| int vtkArrayIteratorTemplate< T >::GetDataType | ( | ) | [virtual] |
Get the data type from the underlying array.
Implements vtkArrayIterator.
| int vtkArrayIteratorTemplate< T >::GetDataTypeSize | ( | ) |
Get the data type size from the underlying array.
Member Data Documentation
T* vtkArrayIteratorTemplate< T >::Pointer [protected] |
Definition at line 96 of file vtkArrayIteratorTemplate.h.
The documentation for this class was generated from the following file:
- dox/Common/vtkArrayIteratorTemplate.h
