vtkHashMapIterator< KeyType, DataType > Class Template Reference

an array map iterator More...

#include <vtkHashMapIterator.h>

Inheritance diagram for vtkHashMapIterator< KeyType, DataType >:

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

[legend]List of all members.

Public Member Functions
int	GetKey (KeyType &)
int	GetData (DataType &)
int	GetKeyAndData (KeyType &, DataType &)
int	SetData (const DataType &)
void	InitTraversal ()
int	IsDoneWithTraversal ()
void	GoToNextItem ()
void	GoToPreviousItem ()
void	GoToFirstItem ()
void	GoToLastItem ()
Protected Types
typedef vtkAbstractMapItem< KeyType, DataType >	ItemType
typedef vtkVectorIterator< ItemType >	BucketIterator
Protected Member Functions
	vtkHashMapIterator ()
virtual	~vtkHashMapIterator ()
void	ScanForward ()
void	ScanBackward ()
Static Protected Member Functions
vtkHashMapIterator< KeyType, DataType > *	New ()
Protected Attributes
vtkIdType	Bucket
BucketIterator *	Iterator
Friends
class	vtkHashMap< KeyType, DataType >

---

Detailed Description

template<class KeyType, class DataType>
class vtkHashMapIterator< KeyType, DataType >

an array map iterator

Definition at line 28 of file vtkHashMapIterator.h.

---

Member Typedef Documentation

template<class KeyType, class DataType> typedef vtkAbstractMapItem<KeyType,DataType> vtkHashMapIterator< KeyType, DataType >::ItemType [protected]

Definition at line 80 of file vtkHashMapIterator.h.

template<class KeyType, class DataType> typedef vtkVectorIterator<ItemType> vtkHashMapIterator< KeyType, DataType >::BucketIterator [protected]

Definition at line 81 of file vtkHashMapIterator.h.

---

Constructor & Destructor Documentation

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

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

---

Member Function Documentation

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

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

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

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

template<class KeyType, class DataType> int vtkHashMapIterator< KeyType, DataType >::GetKeyAndData (  KeyType &  , DataType &  )

Retrieve the key and data of the current element. This method returns VTK_OK if key and data were retrieved correctly.

template<class KeyType, class DataType> int vtkHashMapIterator< KeyType, DataType >::SetData (  const DataType &   )

Set the data at the iterator's position. This method returns VTK_OK if data were set correctly.

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

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

template<class KeyType, class DataType> int vtkHashMapIterator< 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 vtkHashMapIterator< KeyType, DataType >::GoToNextItem (   )

Increment the iterator to the next location.

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

Decrement the iterator to the next location.

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

Go to the "first" item of the map.

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

Go to the "last" item of the map.

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

template<class KeyType, class DataType> void vtkHashMapIterator< KeyType, DataType >::ScanForward (   )  [protected]

template<class KeyType, class DataType> void vtkHashMapIterator< KeyType, DataType >::ScanBackward (   )  [protected]

---

Friends And Related Function Documentation

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

Definition at line 30 of file vtkHashMapIterator.h.

---

Member Data Documentation

template<class KeyType, class DataType> vtkIdType vtkHashMapIterator< KeyType, DataType >::Bucket [protected]

Definition at line 83 of file vtkHashMapIterator.h.

template<class KeyType, class DataType> BucketIterator* vtkHashMapIterator< KeyType, DataType >::Iterator [protected]

Definition at line 84 of file vtkHashMapIterator.h.

---

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

• Common/KWCommon/vtkHashMapIterator.h

---