vtkArrayMapIterator< KeyType, DataType > Class Template Reference

an array map iterator More...

#include <vtkArrayMapIterator.h>

Inheritance diagram for vtkArrayMapIterator< KeyType, DataType >:

[legend]Collaboration diagram for vtkArrayMapIterator< KeyType, DataType >:

[legend]List of all members.

Public Member Functions
int	GetKey (KeyType &)
int	GetData (DataType &)
void	InitTraversal ()
int	IsDoneWithTraversal ()
void	GoToNextItem ()
void	GoToPreviousItem ()
void	GoToFirstItem ()
void	GoToLastItem ()
Protected Member Functions
	vtkArrayMapIterator ()
virtual	~vtkArrayMapIterator ()
Static Protected Member Functions
vtkArrayMapIterator< KeyType, DataType > *	New ()
Protected Attributes
vtkIdType	Index
Friends
class	vtkArrayMap< KeyType, DataType >

---

Detailed Description

template<class KeyType, class DataType>
class vtkArrayMapIterator< KeyType, DataType >

an array map iterator

Definition at line 24 of file vtkArrayMapIterator.h.

---

Constructor & Destructor Documentation

template<class KeyType, class DataType> vtkArrayMapIterator< KeyType, DataType >::vtkArrayMapIterator (   )  [inline, protected]

Definition at line 61 of file vtkArrayMapIterator.h. References vtkArrayMapIterator< KeyType, DataType >::Index.

template<class KeyType, class DataType> virtual vtkArrayMapIterator< KeyType, DataType >::~vtkArrayMapIterator (   )  [inline, protected, virtual]

Definition at line 64 of file vtkArrayMapIterator.h.

---

Member Function Documentation

template<class KeyType, class DataType> int vtkArrayMapIterator< KeyType, DataType >::GetKey (  KeyType &   )

Retrieve the index of the element. This method returns VTK_OK if key was retrieved correctly.

template<class KeyType, class DataType> int vtkArrayMapIterator< KeyType, DataType >::GetData (  DataType &   )

Retrieve the data from the iterator. This method returns VTK_OK if key was retrieved correctly.

template<class KeyType, class DataType> void vtkArrayMapIterator< KeyType, DataType >::InitTraversal (   )

Initialize the traversal of the container. Set the iterator to the "beginning" of the container.

template<class KeyType, class DataType> int vtkArrayMapIterator< KeyType, DataType >::IsDoneWithTraversal (   )

Check if the iterator is at the end of the container. Returns 1 for yes and 0 for no.

template<class KeyType, class DataType> void vtkArrayMapIterator< KeyType, DataType >::GoToNextItem (   )

Increment the iterator to the next location.

template<class KeyType, class DataType> void vtkArrayMapIterator< KeyType, DataType >::GoToPreviousItem (   )

Decrement the iterator to the next location.

template<class KeyType, class DataType> void vtkArrayMapIterator< KeyType, DataType >::GoToFirstItem (   )

Go to the "first" item of the map.

template<class KeyType, class DataType> void vtkArrayMapIterator< KeyType, DataType >::GoToLastItem (   )

Go to the "last" item of the map.

template<class KeyType, class DataType> vtkArrayMapIterator<KeyType,DataType>* vtkArrayMapIterator< KeyType, DataType >::New (   )  [static, protected]

---

Friends And Related Function Documentation

template<class KeyType, class DataType> friend class vtkArrayMap< KeyType, DataType > [friend]

Definition at line 26 of file vtkArrayMapIterator.h.

---

Member Data Documentation

template<class KeyType, class DataType> vtkIdType vtkArrayMapIterator< KeyType, DataType >::Index [protected]

Definition at line 66 of file vtkArrayMapIterator.h. Referenced by vtkArrayMapIterator< KeyType, DataType >::vtkArrayMapIterator().

---

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

• Common/KWCommon/vtkArrayMapIterator.h

---