ACE_Double_Linked_List_Iterator< T > Class Template Reference

Implements an iterator for a double linked list ADT. More...

#include <Containers_T.h>

Inheritance diagram for ACE_Double_Linked_List_Iterator< T >:

Inheritance graph
[legend]
Collaboration diagram for ACE_Double_Linked_List_Iterator< T >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ACE_Double_Linked_List_Iterator (const ACE_Double_Linked_List< T > &)
void reset (ACE_Double_Linked_List< T > &)
int first (void)
int advance (void)
T * advance_and_remove (int dont_remove)
ACE_Double_Linked_List_Iterator<
T > & 
operator++ (void)
 Prefix advance.
ACE_Double_Linked_List_Iterator<
T > 
operator++ (int)
 Postfix advance.
ACE_Double_Linked_List_Iterator<
T > & 
operator-- (void)
 Prefix reverse.
ACE_Double_Linked_List_Iterator<
T > 
operator-- (int)
 Postfix reverse.
void dump (void) const
 Dump the state of an object.

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.

Detailed Description

template<class T>
class ACE_Double_Linked_List_Iterator< T >

Implements an iterator for a double linked list ADT.

Iterate thru the double-linked list. This class provides an interface that let users access the internal element addresses directly. Notice <class t>=""> must declare ACE_Double_Linked_List<T>, ACE_Double_Linked_List_Iterator_Base <T> and ACE_Double_Linked_List_Iterator as friend classes and class T should also have data members T* next_ and T* prev_.


Constructor & Destructor Documentation

template<class T>
ACE_Double_Linked_List_Iterator< T >::ACE_Double_Linked_List_Iterator const ACE_Double_Linked_List< T > &   ) 
 


Member Function Documentation

template<class T>
int ACE_Double_Linked_List_Iterator< T >::advance void   ) 
 

Move forward by one element in the list. Returns 0 when all the items in the list have been seen, else 1.

Reimplemented in ACE_DLList_Iterator< T >.

template<class T>
T * ACE_Double_Linked_List_Iterator< T >::advance_and_remove int  dont_remove  ) 
 

Advance the iterator while removing the original item from the list. Return a pointer points to the original (removed) item. If <dont_remove> equals 0, this function behaves like <advance> but return 0 (NULL) instead.

template<class T>
void ACE_Double_Linked_List_Iterator< T >::dump void   )  const
 

Dump the state of an object.

Reimplemented in ACE_DLList_Iterator< T >.

template<class T>
int ACE_Double_Linked_List_Iterator< T >::first void   ) 
 

Move to the first element in the list. Returns 0 if the list is empty, else 1.

template<class T>
ACE_Double_Linked_List_Iterator< T > ACE_Double_Linked_List_Iterator< T >::operator++ int   ) 
 

Postfix advance.

template<class T>
ACE_Double_Linked_List_Iterator< T > & ACE_Double_Linked_List_Iterator< T >::operator++ void   ) 
 

Prefix advance.

template<class T>
ACE_Double_Linked_List_Iterator< T > ACE_Double_Linked_List_Iterator< T >::operator-- int   ) 
 

Postfix reverse.

template<class T>
ACE_Double_Linked_List_Iterator< T > & ACE_Double_Linked_List_Iterator< T >::operator-- void   ) 
 

Prefix reverse.

template<class T>
void ACE_Double_Linked_List_Iterator< T >::reset ACE_Double_Linked_List< T > &   ) 
 

Retasks the iterator to iterate over a new Double_Linked_List. This allows clients to reuse an iterator without incurring the constructor overhead. If you do use this, be aware that if there are more than one reference to this iterator, the other "clients" may be very bothered when their iterator changes. @ Here be dragons. Comments?

Reimplemented from ACE_Double_Linked_List_Iterator_Base< T >.


Member Data Documentation

template<class T>
ACE_Double_Linked_List_Iterator< T >::ACE_ALLOC_HOOK_DECLARE
 

Declare the dynamic allocation hooks.

Reimplemented from ACE_Double_Linked_List_Iterator_Base< T >.


The documentation for this class was generated from the following files:
Generated on Wed Nov 23 15:48:30 2005 for ACE by  doxygen 1.4.5