vtkQueueIterator< DType > Class Template Reference

a templated vector list iterator More...

#include <vtkQueueIterator.h>

Inheritance diagram for vtkQueueIterator< DType >:

[legend]Collaboration diagram for vtkQueueIterator< DType >:

[legend]List of all members.

Public Member Functions
int	GetKey (vtkIdType &)
int	GetData (DType &)
int	SetData (const DType &)
void	InitTraversal ()
int	IsDoneWithTraversal ()
void	GoToNextItem ()
void	GoToPreviousItem ()
void	GoToFirstItem ()
void	GoToLastItem ()
Protected Member Functions
	vtkQueueIterator ()
virtual	~vtkQueueIterator ()
Static Protected Member Functions
vtkQueueIterator< DType > *	New ()
Protected Attributes
vtkIdType	Index
vtkIdType	Number
Friends
class	vtkQueue< DType >

---

Detailed Description

template<class DType>
class vtkQueueIterator< DType >

a templated vector list iterator

Definition at line 27 of file vtkQueueIterator.h.

---

Constructor & Destructor Documentation

template<class DType> vtkQueueIterator< DType >::vtkQueueIterator (   )  [inline, protected]

Definition at line 69 of file vtkQueueIterator.h. References vtkQueueIterator< DType >::Index, and vtkQueueIterator< DType >::Number.

template<class DType> virtual vtkQueueIterator< DType >::~vtkQueueIterator (   )  [inline, protected, virtual]

Definition at line 73 of file vtkQueueIterator.h.

---

Member Function Documentation

template<class DType> int vtkQueueIterator< DType >::GetKey (  vtkIdType &   )

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

template<class DType> int vtkQueueIterator< DType >::GetData (  DType &   )

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

template<class DType> int vtkQueueIterator< DType >::SetData (  const DType &   )

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

template<class DType> void vtkQueueIterator< DType >::InitTraversal (   )

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

template<class DType> int vtkQueueIterator< DType >::IsDoneWithTraversal (   )

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

template<class DType> void vtkQueueIterator< DType >::GoToNextItem (   )

Increment the iterator to the next location.

template<class DType> void vtkQueueIterator< DType >::GoToPreviousItem (   )

Decrement the iterator to the next location.

template<class DType> void vtkQueueIterator< DType >::GoToFirstItem (   )

Go to the first item of the list.

template<class DType> void vtkQueueIterator< DType >::GoToLastItem (   )

Go to the last item of the list.

template<class DType> vtkQueueIterator<DType>* vtkQueueIterator< DType >::New (   )  [static, protected]

---

Friends And Related Function Documentation

template<class DType> friend class vtkQueue< DType > [friend]

Definition at line 29 of file vtkQueueIterator.h.

---

Member Data Documentation

template<class DType> vtkIdType vtkQueueIterator< DType >::Index [protected]

Definition at line 75 of file vtkQueueIterator.h. Referenced by vtkQueueIterator< DType >::vtkQueueIterator().

template<class DType> vtkIdType vtkQueueIterator< DType >::Number [protected]

Definition at line 76 of file vtkQueueIterator.h. Referenced by vtkQueueIterator< DType >::vtkQueueIterator().

---

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

• Common/KWCommon/vtkQueueIterator.h

---