om::util::LinkedList< T >::ConstIterator Class Reference

Iterator class for a linked list which can't modify it. More...

#include <omLinkedList.h>

Public Member Functions
	ConstIterator (const LinkedList< T > &newList)
	Create a new linked list iterator from a reference to a list. More...
	ConstIterator (const Iterator &iterator)
	Create a new const linked list iterator from a non-const iterator. More...
	operator Bool () const
	Return whether or not the iterator is at the end of the list. More...
void	operator++ ()
	Prefix increment operator. More...
void	operator++ (int)
	Postfix increment operator. More...
const T &	operator* ()
	Return a reference to the current iterator element. More...
const T *	operator-> ()
	Access the current iterator element. More...
void	reset ()
	Reset the iterator to the beginning of the list. More...

Detailed Description

template<typename T>
class om::util::LinkedList< T >::ConstIterator

Iterator class for a linked list which can't modify it.

It's purpose is to efficiently iterate through all or some of the elements in the linked list, making changes as necessary. It avoids the O(n) time of removing or adding elements to the list under ordinary situations.

Constructor & Destructor Documentation

template<typename T >

om::util::LinkedList< T >::ConstIterator::ConstIterator ( const LinkedList< T > &  newList )

inline

Create a new linked list iterator from a reference to a list.

template<typename T >

om::util::LinkedList< T >::ConstIterator::ConstIterator ( const Iterator &  iterator )

inline

Create a new const linked list iterator from a non-const iterator.

Member Function Documentation

template<typename T >

om::util::LinkedList< T >::ConstIterator::operator Bool ( ) const

inline

Return whether or not the iterator is at the end of the list.

If the iterator is at the end of the list, return FALSE. Otherwise, return TRUE.

Returns

FALSE if at the end of list, otherwise TRUE

template<typename T >

void om::util::LinkedList< T >::ConstIterator::operator++ ( )

inline

Prefix increment operator.

template<typename T >

void om::util::LinkedList< T >::ConstIterator::operator++ ( int  )

inline

Postfix increment operator.

template<typename T >

const T& om::util::LinkedList< T >::ConstIterator::operator* ( )

inline

Return a reference to the current iterator element.

template<typename T >

const T* om::util::LinkedList< T >::ConstIterator::operator-> ( )

inline

Access the current iterator element.

template<typename T >

void om::util::LinkedList< T >::ConstIterator::reset ( )

inline

Reset the iterator to the beginning of the list.

---

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

• omLinkedList.h