VTK
Public Types | Public Member Functions
vtkTypedDataArrayIterator< Scalar > Class Template Reference

STL-style random access iterator for vtkTypedDataArrays. More...

#include <vtkTypedDataArrayIterator.h>

List of all members.

Public Types

typedef
std::random_access_iterator_tag 
iterator_category
typedef Scalar value_type
typedef std::ptrdiff_t difference_type
typedef Scalar & reference
typedef Scalar * pointer

Public Member Functions

 vtkTypedDataArrayIterator ()
 vtkTypedDataArrayIterator (vtkTypedDataArray< Scalar > *arr, const vtkIdType index=0)
 vtkTypedDataArrayIterator (const vtkTypedDataArrayIterator &o)
vtkTypedDataArrayIteratoroperator= (vtkTypedDataArrayIterator< Scalar > o)
bool operator== (const vtkTypedDataArrayIterator< Scalar > &o) const
bool operator!= (const vtkTypedDataArrayIterator< Scalar > &o) const
bool operator> (const vtkTypedDataArrayIterator< Scalar > &o) const
bool operator>= (const vtkTypedDataArrayIterator< Scalar > &o) const
bool operator< (const vtkTypedDataArrayIterator< Scalar > &o) const
bool operator<= (const vtkTypedDataArrayIterator< Scalar > &o) const
Scalar & operator* ()
Scalar * operator-> () const
Scalar & operator[] (const difference_type &n)
vtkTypedDataArrayIteratoroperator++ ()
vtkTypedDataArrayIteratoroperator-- ()
vtkTypedDataArrayIterator operator++ (int)
vtkTypedDataArrayIterator operator-- (int)
vtkTypedDataArrayIterator operator+ (const difference_type &n) const
vtkTypedDataArrayIterator operator- (const difference_type &n) const
difference_type operator- (const vtkTypedDataArrayIterator &other) const
vtkTypedDataArrayIteratoroperator+= (const difference_type &n)
vtkTypedDataArrayIteratoroperator-= (const difference_type &n)

Detailed Description

template<class Scalar>
class vtkTypedDataArrayIterator< Scalar >

STL-style random access iterator for vtkTypedDataArrays.

vtkTypedDataArrayIterator provides an STL-style iterator that can be used to interact with instances of vtkTypedDataArray. It is intended to provide an alternative to using vtkDataArray::GetVoidPointer() that only uses vtkTypedDataArray API functions to retrieve values. It is especially helpful for safely iterating through subclasses of vtkMappedDataArray, which may not use the same memory layout as a typical vtkDataArray.

Tests:
vtkTypedDataArrayIterator (Tests)

Definition at line 40 of file vtkTypedDataArrayIterator.h.


Member Typedef Documentation

template<class Scalar>
typedef std::random_access_iterator_tag vtkTypedDataArrayIterator< Scalar >::iterator_category

Definition at line 43 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
typedef Scalar vtkTypedDataArrayIterator< Scalar >::value_type

Definition at line 44 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
typedef std::ptrdiff_t vtkTypedDataArrayIterator< Scalar >::difference_type

Definition at line 45 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
typedef Scalar& vtkTypedDataArrayIterator< Scalar >::reference

Definition at line 46 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
typedef Scalar* vtkTypedDataArrayIterator< Scalar >::pointer

Definition at line 47 of file vtkTypedDataArrayIterator.h.


Constructor & Destructor Documentation

template<class Scalar>
vtkTypedDataArrayIterator< Scalar >::vtkTypedDataArrayIterator ( ) [inline]

Definition at line 49 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
vtkTypedDataArrayIterator< Scalar >::vtkTypedDataArrayIterator ( vtkTypedDataArray< Scalar > *  arr,
const vtkIdType  index = 0 
) [inline, explicit]

Definition at line 52 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
vtkTypedDataArrayIterator< Scalar >::vtkTypedDataArrayIterator ( const vtkTypedDataArrayIterator< Scalar > &  o) [inline]

Definition at line 59 of file vtkTypedDataArrayIterator.h.


Member Function Documentation

template<class Scalar>
vtkTypedDataArrayIterator& vtkTypedDataArrayIterator< Scalar >::operator= ( vtkTypedDataArrayIterator< Scalar >  o) [inline]

Definition at line 66 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
bool vtkTypedDataArrayIterator< Scalar >::operator== ( const vtkTypedDataArrayIterator< Scalar > &  o) const [inline]

Definition at line 73 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
bool vtkTypedDataArrayIterator< Scalar >::operator!= ( const vtkTypedDataArrayIterator< Scalar > &  o) const [inline]

Definition at line 78 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
bool vtkTypedDataArrayIterator< Scalar >::operator> ( const vtkTypedDataArrayIterator< Scalar > &  o) const [inline]

Definition at line 83 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
bool vtkTypedDataArrayIterator< Scalar >::operator>= ( const vtkTypedDataArrayIterator< Scalar > &  o) const [inline]

Definition at line 88 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
bool vtkTypedDataArrayIterator< Scalar >::operator< ( const vtkTypedDataArrayIterator< Scalar > &  o) const [inline]

Definition at line 93 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
bool vtkTypedDataArrayIterator< Scalar >::operator<= ( const vtkTypedDataArrayIterator< Scalar > &  o) const [inline]

Definition at line 98 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
Scalar& vtkTypedDataArrayIterator< Scalar >::operator* ( ) [inline]

Definition at line 103 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
Scalar* vtkTypedDataArrayIterator< Scalar >::operator-> ( ) const [inline]

Definition at line 108 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
Scalar& vtkTypedDataArrayIterator< Scalar >::operator[] ( const difference_type n) [inline]

Definition at line 113 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
vtkTypedDataArrayIterator& vtkTypedDataArrayIterator< Scalar >::operator++ ( void  ) [inline]

Definition at line 118 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
vtkTypedDataArrayIterator& vtkTypedDataArrayIterator< Scalar >::operator-- ( void  ) [inline]

Definition at line 124 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
vtkTypedDataArrayIterator vtkTypedDataArrayIterator< Scalar >::operator++ ( int  ) [inline]

Definition at line 130 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
vtkTypedDataArrayIterator vtkTypedDataArrayIterator< Scalar >::operator-- ( int  ) [inline]

Definition at line 135 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
vtkTypedDataArrayIterator vtkTypedDataArrayIterator< Scalar >::operator+ ( const difference_type n) const [inline]

Definition at line 140 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
vtkTypedDataArrayIterator vtkTypedDataArrayIterator< Scalar >::operator- ( const difference_type n) const [inline]

Definition at line 145 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
difference_type vtkTypedDataArrayIterator< Scalar >::operator- ( const vtkTypedDataArrayIterator< Scalar > &  other) const [inline]

Definition at line 150 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
vtkTypedDataArrayIterator& vtkTypedDataArrayIterator< Scalar >::operator+= ( const difference_type n) [inline]

Definition at line 155 of file vtkTypedDataArrayIterator.h.

template<class Scalar>
vtkTypedDataArrayIterator& vtkTypedDataArrayIterator< Scalar >::operator-= ( const difference_type n) [inline]

Definition at line 161 of file vtkTypedDataArrayIterator.h.


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