OE_LIST< _UserType >::iterator Class Reference

#include <common.h>

List of all members.


Detailed Description

template<typename _UserType>
class OE_LIST< _UserType >::iterator

Iterator over OE_LIST.

This iterator can move around the list, and allows modification of the list data

Definition at line 79 of file common.h.

Public Member Functions

 iterator ()
 Create uninitialized iterator.
void move_next ()
 Moves this iterator one position forward in the list.
void move_prev ()
 Moves this iterator one position back in the list.
bool is_valid ()
 Returns true if iterator is still valid (non-NULL) and can be used, false otherwise.
iterator get_next ()
 Returns iterator to following element in list.
iterator get_prev ()
 Returns iterator to preceding element in list.
bool is_first ()
 Returns true if this iterator points to first element of the list.
bool is_last ()
 Returns true if this iterator points to last element of the list.


Constructor & Destructor Documentation

template<typename _UserType>
OE_LIST< _UserType >::iterator::iterator (  )  [inline]

Create uninitialized iterator.

Note:
By default, iterators are automatically initialized to NULL.

Definition at line 96 of file common.h.

Referenced by OE_LIST< _UserType >::iterator::get_next(), and OE_LIST< _UserType >::iterator::get_prev().


Member Function Documentation

template<typename _UserType>
void OE_LIST< _UserType >::iterator::move_next (  )  [inline]

Moves this iterator one position forward in the list.

Note:
It is NOT allowed to call this on "invalid" iterators.

Definition at line 104 of file common.h.

template<typename _UserType>
void OE_LIST< _UserType >::iterator::move_prev (  )  [inline]

Moves this iterator one position back in the list.

Note:
It is NOT allowed to call this on "invalid" iterators.

Definition at line 113 of file common.h.

template<typename _UserType>
bool OE_LIST< _UserType >::iterator::is_valid (  )  [inline]

Returns true if iterator is still valid (non-NULL) and can be used, false otherwise.

Definition at line 120 of file common.h.

template<typename _UserType>
iterator OE_LIST< _UserType >::iterator::get_next (  )  [inline]

Returns iterator to following element in list.

Note:
It is NOT allowed to call this on "invalid" iterators.

Definition at line 128 of file common.h.

template<typename _UserType>
iterator OE_LIST< _UserType >::iterator::get_prev (  )  [inline]

Returns iterator to preceding element in list.

Note:
It is NOT allowed to call this on "invalid" iterators.

Definition at line 137 of file common.h.

template<typename _UserType>
bool OE_LIST< _UserType >::iterator::is_first (  )  [inline]

Returns true if this iterator points to first element of the list.

In case of empty list: returns true if iterator is "invalid", or false if iterator is valid.

Note:
It is NOT allowed to call this on "invalid" iterators.

Definition at line 148 of file common.h.

template<typename _UserType>
bool OE_LIST< _UserType >::iterator::is_last (  )  [inline]

Returns true if this iterator points to last element of the list.

In case of empty list: returns true if iterator is "invalid", or false if iterator is valid.

Note:
It is NOT allowed to call this on "invalid" iterators.

Definition at line 159 of file common.h.


The documentation for this class was generated from the following file:
Generated on Sat Sep 9 03:50:53 2006 for Openem APIs by  doxygen 1.4.7