om::util::ShortArrayList< T, localCapacity, SizeType >::ConstIterator Class Reference

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

#include <omShortArrayList.h>

Public Member Functions
	ConstIterator (const ShortArrayList &newList)
	Create a new ShortArrayList iterator from a reference to a list. More...
	ConstIterator (const Iterator &iterator)
	Create a new const short 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	getSizeType () const
	Get the index of the next element to be iterated over. More...

Detailed Description

template<typename T, Size localCapacity = Size(4), typename SizeType = Size>
class om::util::ShortArrayList< T, localCapacity, SizeType >::ConstIterator

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

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

Constructor & Destructor Documentation

template<typename T, Size localCapacity = Size(4), typename SizeType = Size>

om::util::ShortArrayList< T, localCapacity, SizeType >::ConstIterator::ConstIterator ( const ShortArrayList &  newList )

inline

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

template<typename T, Size localCapacity = Size(4), typename SizeType = Size>

om::util::ShortArrayList< T, localCapacity, SizeType >::ConstIterator::ConstIterator ( const Iterator &  iterator )

inline

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

Member Function Documentation

template<typename T, Size localCapacity = Size(4), typename SizeType = Size>

void om::util::ShortArrayList< T, localCapacity, SizeType >::ConstIterator::operator++ ( )

inline

Prefix increment operator.

template<typename T, Size localCapacity = Size(4), typename SizeType = Size>

void om::util::ShortArrayList< T, localCapacity, SizeType >::ConstIterator::operator++ ( int  )

inline

Postfix increment operator.

template<typename T, Size localCapacity = Size(4), typename SizeType = Size>

om::util::ShortArrayList< T, localCapacity, SizeType >::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, Size localCapacity = Size(4), typename SizeType = Size>

const T& om::util::ShortArrayList< T, localCapacity, SizeType >::ConstIterator::operator* ( ) const

inline

Return a const-reference to the current iterator element.

template<typename T, Size localCapacity = Size(4), typename SizeType = Size>

const T* om::util::ShortArrayList< T, localCapacity, SizeType >::ConstIterator::operator-> ( ) const

inline

Access the current iterator element.

template<typename T, Size localCapacity = Size(4), typename SizeType = Size>

void om::util::ShortArrayList< T, localCapacity, SizeType >::ConstIterator::reset ( )

inline

Reset the iterator to the beginning of the list.

template<typename T, Size localCapacity = Size(4), typename SizeType = Size>

SizeType om::util::ShortArrayList< T, localCapacity, SizeType >::ConstIterator::getSizeType ( ) const

inline

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

---

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

• omShortArrayList.h