om::util::ArrayList< T, SizeType, AllocatorType >::ConstIterator Class Reference

An iterator class for an array list which can't modify it. More...

#include <omArrayList.h>

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

Detailed Description

template<typename T, typename SizeType = Size, typename AllocatorType = Allocator>
class om::util::ArrayList< T, SizeType, AllocatorType >::ConstIterator

An iterator class for an array list which can't modify it.

The purpose of this class is to iterate through all or some of the elements in the array list.

Constructor & Destructor Documentation

template<typename T, typename SizeType = Size, typename AllocatorType = Allocator>

om::util::ArrayList< T, SizeType, AllocatorType >::ConstIterator::ConstIterator ( const ArrayList &  newList )

inline

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

template<typename T, typename SizeType = Size, typename AllocatorType = Allocator>

om::util::ArrayList< T, SizeType, AllocatorType >::ConstIterator::ConstIterator ( const Iterator &  iterator )

inline

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

Member Function Documentation

template<typename T, typename SizeType = Size, typename AllocatorType = Allocator>

void om::util::ArrayList< T, SizeType, AllocatorType >::ConstIterator::operator++ ( )

inline

Prefix increment operator.

template<typename T, typename SizeType = Size, typename AllocatorType = Allocator>

void om::util::ArrayList< T, SizeType, AllocatorType >::ConstIterator::operator++ ( int  )

inline

Postfix increment operator.

template<typename T, typename SizeType = Size, typename AllocatorType = Allocator>

om::util::ArrayList< T, SizeType, AllocatorType >::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, indicating that there are more elements to iterate over.

Returns

FALSE if at the end of list, otherwise TRUE.

template<typename T, typename SizeType = Size, typename AllocatorType = Allocator>

const T& om::util::ArrayList< T, SizeType, AllocatorType >::ConstIterator::operator* ( ) const

inline

Return a const-reference to the current iterator element.

template<typename T, typename SizeType = Size, typename AllocatorType = Allocator>

const T* om::util::ArrayList< T, SizeType, AllocatorType >::ConstIterator::operator-> ( ) const

inline

Access the current iterator element.

template<typename T, typename SizeType = Size, typename AllocatorType = Allocator>

void om::util::ArrayList< T, SizeType, AllocatorType >::ConstIterator::reset ( )

inline

Reset the iterator to the beginning of the list.

template<typename T, typename SizeType = Size, typename AllocatorType = Allocator>

SizeType om::util::ArrayList< T, SizeType, AllocatorType >::ConstIterator::getIndex ( ) const

inline

Return the index of the next element to be iterated over.

---

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

• omArrayList.h