fe::List< T >::Iterator Class Reference

Type-specific Iterator for an fe::List <> More...

#include <List.h>

Inheritance diagram for fe::List< T >::Iterator:

Public Member Functions
	Iterator (List< T > &rList)
	Iterator (const Iterator &rOperand)
Iterator &	operator= (Iterator &rOperand)
BWORD	operator== (const Iterator &rOperand) const
	Compare by content (not by pointer) More...
BWORD	operator!= (const Iterator &rOperand) const
	Inverse compare by content (not by pointer) More...
T	operator-> (void)
	Use the entry pointed at. More...
T	operator* (void)
	Return the entry pointed at. More...
Iterator &	operator++ (void)
	Pre Increment. More...
Iterator &	operator-- (void)
	Pre Decrement. More...
Iterator	operator++ (int)
	Post Increment. More...
Iterator	operator-- (int)
	Post Decrement. More...
T	toHead (void)
	Point the iterator at the first entry. More...
T	toTail (void)
	Point the iterator at the last entry. More...
BWORD	isAtHeadNull (void)
	Returns TRUE if pointing to the head NULL. More...
BWORD	isAtTailNull (void)
	Returns TRUE if pointing to the tail NULL. More...
T *	insertBefore (T pEntry)
	Add a new entry directly before this iterator. More...
T *	insertAfter (T pEntry)
	Add a new entry directly after this iterator. More...
BWORD	moveCurrentBefore (const Iterator &rOperand)
	Move the entry at this iterator to the position before the argument. More...
BWORD	moveCurrentAfter (const Iterator &rOperand)
	Move the entry at this iterator to the position after the argument. More...
BWORD	remove (void)
	Remove this entry from the list. More...
T	replace (T pSubstitute)
	Replace this entry with a new object. More...
BWORD	deleteEntry (void)
	Remove this entry from the list and delete it. More...
T	searchForElement (const T pEntry)
	Point the iterator at the first entry with a given pointer. More...
T	searchForContent (const T pValue)
	Point the iterator at the first entry equivalent to the given pointed-to value. More...
List *	list (void)

Private Attributes
List *	m_pList

Additional Inherited Members
Protected Member Functions inherited from fe::ListCore::Context
	Context (const Context &operand)
	Copy constructor. More...
Context &	operator= (Context &operand)
	Copy state from another context. More...
void	init (void)
	Reinitialize state. More...
NodeCore *	current (void)
	Get current position on list. More...
void	setCurrent (NodeCore *set)
	Set current position on list. More...
void	setAtTailNull (BWORD set)
	Set whether context is after the tail. More...
BWORD	isAtTailNull (void) const
	Get whether context is after the tail. More...

Detailed Description

template<typename T>
class fe::List< T >::Iterator

Type-specific Iterator for an fe::List <>

This is a templated wrapper for the type-non-specific fe::ListCore::Context.

Member Function Documentation

deleteEntry()

template<typename T>

BWORD fe::List< T >::Iterator::deleteEntry ( void  )

inline

Remove this entry from the list and delete it.

insertAfter()

template<typename T>

T* fe::List< T >::Iterator::insertAfter ( T  pEntry )

inline

Add a new entry directly after this iterator.

insertBefore()

template<typename T>

T* fe::List< T >::Iterator::insertBefore ( T  pEntry )

inline

Add a new entry directly before this iterator.

isAtHeadNull()

template<typename T>

BWORD fe::List< T >::Iterator::isAtHeadNull ( void  )

inline

Returns TRUE if pointing to the head NULL.

isAtTailNull()

template<typename T>

BWORD fe::List< T >::Iterator::isAtTailNull ( void  )

inline

Returns TRUE if pointing to the tail NULL.

moveCurrentAfter()

template<typename T>

BWORD fe::List< T >::Iterator::moveCurrentAfter ( const Iterator &  rOperand )

inline

Move the entry at this iterator to the position after the argument.

moveCurrentBefore()

template<typename T>

BWORD fe::List< T >::Iterator::moveCurrentBefore ( const Iterator &  rOperand )

inline

Move the entry at this iterator to the position before the argument.

operator!=()

template<typename T>

BWORD fe::List< T >::Iterator::operator!= ( const Iterator &  rOperand ) const

inline

Inverse compare by content (not by pointer)

operator*()

template<typename T>

T fe::List< T >::Iterator::operator* ( void  )

inline

Return the entry pointed at.

operator++() [1/2]

template<typename T>

Iterator& fe::List< T >::Iterator::operator++ ( void  )

inline

Pre Increment.

operator++() [2/2]

template<typename T>

Iterator fe::List< T >::Iterator::operator++ ( int  )

inline

Post Increment.

operator--() [1/2]

template<typename T>

Iterator& fe::List< T >::Iterator::operator-- ( void  )

inline

Pre Decrement.

operator--() [2/2]

template<typename T>

Iterator fe::List< T >::Iterator::operator-- ( int  )

inline

Post Decrement.

operator->()

template<typename T>

T fe::List< T >::Iterator::operator-> ( void  )

inline

Use the entry pointed at.

operator==()

template<typename T>

BWORD fe::List< T >::Iterator::operator== ( const Iterator &  rOperand ) const

inline

Compare by content (not by pointer)

remove()

template<typename T>

BWORD fe::List< T >::Iterator::remove ( void  )

inline

Remove this entry from the list.

replace()

template<typename T>

T fe::List< T >::Iterator::replace ( T  pSubstitute )

inline

Replace this entry with a new object.

The previous entry is returned.

searchForContent()

template<typename T>

T fe::List< T >::Iterator::searchForContent ( const T  pValue )

inline

Point the iterator at the first entry equivalent to the given pointed-to value.

searchForElement()

template<typename T>

T fe::List< T >::Iterator::searchForElement ( const T  pEntry )

inline

Point the iterator at the first entry with a given pointer.

toHead()

template<typename T>

T fe::List< T >::Iterator::toHead ( void  )

inline

Point the iterator at the first entry.

toTail()

template<typename T>

T fe::List< T >::Iterator::toTail ( void  )

inline

Point the iterator at the last entry.

---

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

• List.h