Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

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_.

Definition at line 656 of file Containers_T.h.

Constructor & Destructor Documentation

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

Definition at line 454 of file Containers_T.cpp.

References ACE_Double_Linked_List< T >::head_. 

00455   : ACE_Double_Linked_List_Iterator_Base <T> (dll)
00456 {
00457   this->current_ = static_cast<T*> (dll.head_->next_);
00458   // Advance current_ out of the null area and onto the first item in
00459   // the list
00460 }

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 >.

Definition at line 478 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::do_advance().

Referenced by ACE_Thread_Manager::apply_all(), ACE_Thread_Manager::apply_grp(), ACE_Thread_Manager::apply_task(), ACE_Double_Linked_List< T >::copy_nodes(), ACE_Thread_Manager::dump(), ACE_Thread_Manager::find_hthread(), ACE_Thread_Manager::find_task(), ACE_Thread_Manager::find_thread(), ACE_Double_Linked_List< T >::get(), ACE_Thread_Manager::hthread_grp_list(), ACE_Thread_Manager::hthread_list(), ACE_Thread_Manager::hthread_within(), ACE_Thread_Manager::join(), ACE_Thread_Manager::num_tasks_in_group(), ACE_Thread_Manager::num_threads_in_task(), ACE_Thread_Manager::set_grp(), ACE_Thread_Manager::task_all_list(), ACE_Thread_Manager::task_list(), ACE_Thread_Manager::thread_all_list(), ACE_Thread_Manager::thread_grp_list(), ACE_Thread_Manager::thread_list(), ACE_Thread_Manager::thread_within(), ACE_Thread_Manager::wait(), ACE_Thread_Manager::wait_grp(), and ACE_Thread_Manager::wait_task(). 

00479 {
00480   return this->do_advance () ? 1 : 0;
00481 }

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.

Definition at line 484 of file Containers_T.cpp.

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

Referenced by ACE_Thread_Manager::join(), ACE_Thread_Manager::wait_grp(), and ACE_Thread_Manager::wait_task(). 

00485 {
00486   T* item = 0;
00487   if (dont_remove)
00488     this->do_advance ();
00489   else
00490     {
00491       item = this->next ();
00492       this->do_advance ();
00493       // It seems dangerous to remove nodes in an iterator, but so it goes...
00494       ACE_Double_Linked_List<T> *dllist =
00495         const_cast<ACE_Double_Linked_List<T> *> (this->dllist_);
00496       dllist->remove (item);
00497     }
00498   return item;
00499 }

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 >.

Definition at line 502 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::dump_i(). 

00503 {
00504 #if defined (ACE_HAS_DUMP)
00505   this->dump_i ();
00506 #endif /* ACE_HAS_DUMP */
00507 }

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.

Definition at line 472 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::go_head(). 

00473 {
00474   return this->go_head ();
00475 }

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

Postfix advance.

Definition at line 524 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::do_advance(). 

00525 {
00526   ACE_Double_Linked_List_Iterator<T> retv (*this);
00527   this->do_advance ();
00528   return retv;
00529 }

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

Prefix advance.

Definition at line 513 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::do_advance(). 

00514 {
00515   this->do_advance ();
00516   return *this;
00517 }

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

Postfix reverse.

Definition at line 547 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::do_retreat(). 

00548 {
00549   ACE_Double_Linked_List_Iterator<T> retv (*this);
00550   this->do_retreat ();
00551   return retv;
00552 }

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

Prefix reverse.

Definition at line 536 of file Containers_T.cpp.

References ACE_Double_Linked_List_Iterator_Base< T >::do_retreat(). 

00537 {
00538   this->do_retreat ();
00539   return *this;
00540 }

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 >.

Definition at line 463 of file Containers_T.cpp.

References ACE_Double_Linked_List< T >::head_. 

00464 {
00465   this->ACE_Double_Linked_List_Iterator_Base <T>::reset (dll);
00466   this->current_ = static_cast<T*> (dll.head_->next_);
00467   // Advance current_ out of the null area and onto the first item in
00468   // the list
00469 }

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 >.

Definition at line 707 of file Containers_T.h.

The documentation for this class was generated from the following files:
Generated on Thu Nov 9 11:21:48 2006 for ACE by doxygen 1.3.6