ACE_Double_Linked_List_Reverse_Iterator< T > Class Template Reference

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

#include <Containers_T.h>

Inheritance diagram for ACE_Double_Linked_List_Reverse_Iterator< T >:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ACE_Double_Linked_List_Reverse_Iterator (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_Reverse_Iterator<
T > & 		operator++ (void)
 Prefix advance.
ACE_Double_Linked_List_Reverse_Iterator<
T > 		operator++ (int)
 Postfix advance.
ACE_Double_Linked_List_Reverse_Iterator<
T > & 		operator-- (void)
 Prefix reverse.
ACE_Double_Linked_List_Reverse_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_Reverse_Iterator< T >

Implements a reverse iterator for a double linked list ADT.

Iterate backwards over the double-linked list. This class provide an interface that let users access the internal element addresses directly, which seems to break the encapsulation. 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_.

Definition at line 723 of file Containers_T.h.

Constructor & Destructor Documentation

template<class T>
ACE_Double_Linked_List_Reverse_Iterator< T >::ACE_Double_Linked_List_Reverse_Iterator ( ACE_Double_Linked_List< T > &   ) 

Definition at line 559 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::current_.

00560   : ACE_Double_Linked_List_Iterator_Base <T> (dll)
00561 {
00562   this->current_ = static_cast<T*> (dll.head_->prev_);
00563   // Advance current_ out of the null area and onto the last item in
00564   // the list
00565 }

Member Function Documentation

template<class T>
int ACE_Double_Linked_List_Reverse_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_Reverse_Iterator< T >.

Definition at line 583 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::do_retreat().

00584 {
00585   return this->do_retreat () ? 1 : 0;
00586 }

template<class T>
T * ACE_Double_Linked_List_Reverse_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.

Definition at line 589 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::dllist_, ACE_Double_Linked_List_Iterator_Base< T >::do_retreat(), ACE_Double_Linked_List_Iterator_Base< T >::next(), and ACE_Double_Linked_List< T >::remove().

00590 {
00591   T* item = 0;
00592   if (dont_remove)
00593     this->do_retreat ();
00594   else
00595     {
00596       item = this->next ();
00597       this->do_retreat ();
00598       // It seems dangerous to remove nodes in an iterator, but so it goes...
00599       ACE_Double_Linked_List<T> *dllist =
00600         const_cast<ACE_Double_Linked_List<T> *> (this->dllist_);
00601       dllist->remove (item);
00602     }
00603   return item;
00604 }

template<class T>
void ACE_Double_Linked_List_Reverse_Iterator< T >::dump ( void   )  const

Dump the state of an object.

Reimplemented in ACE_DLList_Reverse_Iterator< T >.

Definition at line 607 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::dump_i().

00608 {
00609 #if defined (ACE_HAS_DUMP)
00610   this->dump_i ();
00611 #endif /* ACE_HAS_DUMP */
00612 }

template<class T>
int ACE_Double_Linked_List_Reverse_Iterator< T >::first ( void   ) 

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

Definition at line 577 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::go_tail().

00578 {
00579   return this->go_tail ();
00580 }

template<class T>
ACE_Double_Linked_List_Reverse_Iterator< T > ACE_Double_Linked_List_Reverse_Iterator< T >::operator++ ( int   ) 

Postfix advance.

Definition at line 629 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::do_retreat().

00630 {
00631   ACE_Double_Linked_List_Reverse_Iterator<T> retv (*this);
00632   this->do_retreat ();
00633   return retv;
00634 }

template<class T>
ACE_Double_Linked_List_Reverse_Iterator< T > & ACE_Double_Linked_List_Reverse_Iterator< T >::operator++ ( void   ) 

Prefix advance.

Definition at line 618 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::do_retreat().

00619 {
00620   this->do_retreat ();
00621   return *this;
00622 }

template<class T>
ACE_Double_Linked_List_Reverse_Iterator< T > ACE_Double_Linked_List_Reverse_Iterator< T >::operator-- ( int   ) 

Postfix reverse.

Definition at line 652 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::do_advance().

00653 {
00654   ACE_Double_Linked_List_Reverse_Iterator<T> retv (*this);
00655   this->do_advance ();
00656   return retv;
00657 }

template<class T>
ACE_Double_Linked_List_Reverse_Iterator< T > & ACE_Double_Linked_List_Reverse_Iterator< T >::operator-- ( void   ) 

Prefix reverse.

Definition at line 641 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::do_advance().

00642 {
00643   this->do_advance ();
00644   return *this;
00645 }

template<class T>
void ACE_Double_Linked_List_Reverse_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 >.

Definition at line 568 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::current_, and ACE_Double_Linked_List< T >::head_.

00569 {
00570   this->ACE_Double_Linked_List_Iterator_Base <T>::reset (dll);
00571   this->current_ = static_cast<T*> (dll.head_->prev_);
00572   // Advance current_ out of the null area and onto the last item in
00573   // the list
00574 }

Member Data Documentation

template<class T>
ACE_Double_Linked_List_Reverse_Iterator< T >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Reimplemented from ACE_Double_Linked_List_Iterator_Base< T >.

Definition at line 774 of file Containers_T.h.

The documentation for this class was generated from the following files:
Generated on Tue Feb 2 17:35:05 2010 for ACE by  doxygen 1.4.7