Open
Graph Drawing
Framework

 v.2007.11
 

ogdf::ListConstIterator< E > Class Template Reference

The parameterized class ListIterator<E> encapsulates a constant pointer to a list element. More...

#include <List.h>

List of all members.

Public Member Functions

 ListConstIterator ()
 Constructs an iterator pointing to no element.
 ListConstIterator (const ListElement< E > *pX)
 Constructs an iterator pointing to pX.
 ListConstIterator (const ListIterator< E > &it)
 Constructs an iterator that is a copy of it.
 ListConstIterator (const ListConstIterator &it)
 Constructs an iterator that is a copy of it.
bool valid () const
 Returns true iff the iterator points to an element.
bool operator== (const ListConstIterator< E > &it) const
 Equality operator.
bool operator!= (const ListConstIterator< E > &it) const
 Inequality operator.
ListConstIterator< E > succ () const
 Returns successor iterator.
ListConstIterator< E > pred () const
 Returns predecessor iterator.
const E & operator * () const
 Returns a reference to the element content.
ListConstIterator< E > & operator= (const ListConstIterator< E > &it)
 Assignment operator.
ListConstIterator< E > & operator++ ()
 Increment operator (prefix).
ListConstIterator< E > operator++ (int)
 Increment operator (postfix).
ListConstIterator< E > & operator-- ()
 Decrement operator (prefix).
ListConstIterator< E > operator-- (int)
 Decrement operator (postfix).
void * operator new (size_t nBytes)
void * operator new (size_t, void *p)
void operator delete (void *p, size_t nBytes)

Private Member Functions

 operator const ListElement< E > * ()
 Conversion to pointer to list element.

Private Attributes

const ListElement< E > * m_pX

Friends

class ListPure< E >


Detailed Description

template<class E>
class ogdf::ListConstIterator< E >

The parameterized class ListIterator<E> encapsulates a constant pointer to a list element.

It is used in order to iterate over doubly linked lists, and to specify a position in a doubly linked list. It is possible that an iterator encapsulates a null pointer. In contrast to ListIterator, it is not possible to change the list element pointed to.

Definition at line 192 of file List.h.


Constructor & Destructor Documentation

template<class E>
ogdf::ListConstIterator< E >::ListConstIterator (  )  [inline]

Constructs an iterator pointing to no element.

Definition at line 202 of file List.h.

template<class E>
ogdf::ListConstIterator< E >::ListConstIterator ( const ListElement< E > *  pX  )  [inline]

Constructs an iterator pointing to pX.

Definition at line 205 of file List.h.

template<class E>
ogdf::ListConstIterator< E >::ListConstIterator ( const ListIterator< E > &  it  )  [inline]

Constructs an iterator that is a copy of it.

Definition at line 208 of file List.h.

template<class E>
ogdf::ListConstIterator< E >::ListConstIterator ( const ListConstIterator< E > &  it  )  [inline]

Constructs an iterator that is a copy of it.

Definition at line 210 of file List.h.


Member Function Documentation

template<class E>
ogdf::ListConstIterator< E >::operator const ListElement< E > * (  )  [inline, private]

Conversion to pointer to list element.

Definition at line 198 of file List.h.

template<class E>
bool ogdf::ListConstIterator< E >::valid (  )  const [inline]

Returns true iff the iterator points to an element.

Definition at line 213 of file List.h.

template<class E>
bool ogdf::ListConstIterator< E >::operator== ( const ListConstIterator< E > &  it  )  const [inline]

Equality operator.

Definition at line 216 of file List.h.

template<class E>
bool ogdf::ListConstIterator< E >::operator!= ( const ListConstIterator< E > &  it  )  const [inline]

Inequality operator.

Definition at line 221 of file List.h.

template<class E>
ListConstIterator<E> ogdf::ListConstIterator< E >::succ (  )  const [inline]

Returns successor iterator.

Definition at line 226 of file List.h.

template<class E>
ListConstIterator<E> ogdf::ListConstIterator< E >::pred (  )  const [inline]

Returns predecessor iterator.

Definition at line 229 of file List.h.

template<class E>
const E& ogdf::ListConstIterator< E >::operator * (  )  const [inline]

Returns a reference to the element content.

Definition at line 232 of file List.h.

template<class E>
ListConstIterator<E>& ogdf::ListConstIterator< E >::operator= ( const ListConstIterator< E > &  it  )  [inline]

Assignment operator.

Definition at line 235 of file List.h.

template<class E>
ListConstIterator<E>& ogdf::ListConstIterator< E >::operator++ (  )  [inline]

Increment operator (prefix).

Definition at line 241 of file List.h.

template<class E>
ListConstIterator<E> ogdf::ListConstIterator< E >::operator++ ( int   )  [inline]

Increment operator (postfix).

Definition at line 247 of file List.h.

template<class E>
ListConstIterator<E>& ogdf::ListConstIterator< E >::operator-- (  )  [inline]

Decrement operator (prefix).

Definition at line 254 of file List.h.

template<class E>
ListConstIterator<E> ogdf::ListConstIterator< E >::operator-- ( int   )  [inline]

Decrement operator (postfix).

Definition at line 260 of file List.h.

template<class E>
void* ogdf::ListConstIterator< E >::operator new ( size_t  nBytes  )  [inline]

Definition at line 266 of file List.h.

template<class E>
void* ogdf::ListConstIterator< E >::operator new ( size_t  ,
void *  p 
) [inline]

Definition at line 266 of file List.h.

template<class E>
void ogdf::ListConstIterator< E >::operator delete ( void *  p,
size_t  nBytes 
) [inline]

Definition at line 266 of file List.h.


Friends And Related Function Documentation

template<class E>
friend class ListPure< E > [friend]

Definition at line 195 of file List.h.


Member Data Documentation

template<class E>
const ListElement<E>* ogdf::ListConstIterator< E >::m_pX [private]

Definition at line 193 of file List.h.


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

© 1999-2007 by oreas GmbH, © 2005-2007 by University Dortmund and University Cologne.

Generated on Thu Nov 22 19:40:08 2007 by doxygen 1.5.4.