ACE_Double_Linked_List_Iterator_Base Class Reference

Implements a common base class for iterators for a double linked list ADT. More...

#include <Containers_T.h>

Collaboration diagram for ACE_Double_Linked_List_Iterator_Base:

Public Member Functions
int	next (T *&) const
T *	next (void) const
int	done (void) const
	Returns 1 when all items have been seen, else 0. More...
T &	operator* (void) const
void	reset (ACE_Double_Linked_List< T > &)

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

Protected Member Functions
	ACE_Double_Linked_List_Iterator_Base (const ACE_Double_Linked_List< T > &)
	Constructor. More...
	ACE_Double_Linked_List_Iterator_Base (const ACE_Double_Linked_List_Iterator_Base< T > &iter)
	Copy constructor. More...
int	go_head (void)
int	go_tail (void)
T *	not_done (void) const
T *	do_advance (void)
T *	do_retreat (void)
void	dump_i (void) const
	Dump the state of an object. More...

Protected Attributes
T *	current_
	Remember where we are. More...
const ACE_Double_Linked_List< T > *	dllist_

Detailed Description

Implements a common base class for iterators for a double linked list ADT.

Constructor & Destructor Documentation

ACE_Double_Linked_List_Iterator_Base() [1/2]

ACE_Double_Linked_List_Iterator_Base::ACE_Double_Linked_List_Iterator_Base ( const ACE_Double_Linked_List< T > &  )

protected

Constructor.

ACE_Double_Linked_List_Iterator_Base() [2/2]

ACE_Double_Linked_List_Iterator_Base::ACE_Double_Linked_List_Iterator_Base ( const ACE_Double_Linked_List_Iterator_Base< T > &  iter )

protected

Copy constructor.

Member Function Documentation

do_advance()

T * ACE_Double_Linked_List_Iterator_Base::do_advance ( void  )

protected

Advance to the next element in the list. Return the address of the next element if there are more, 0 otherwise.

do_retreat()

T * ACE_Double_Linked_List_Iterator_Base::do_retreat ( void  )

protected

Retreat to the previous element in the list. Return the address of the previous element if there are more, 0 otherwise.

done()

int ACE_Double_Linked_List_Iterator_Base::done

(

void

)

const

Returns 1 when all items have been seen, else 0.

dump_i()

void ACE_Double_Linked_List_Iterator_Base::dump_i ( void  ) const

protected

Dump the state of an object.

go_head()

int ACE_Double_Linked_List_Iterator_Base::go_head ( void  )

protected

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

Note

the head of the ACE_DLList is actually a null entry, so the first element is actually the 2n'd entry

go_tail()

int ACE_Double_Linked_List_Iterator_Base::go_tail ( void  )

protected

Move to the last element of the list. Returns 0 if the list is empty, else 1.

next() [1/2]

int ACE_Double_Linked_List_Iterator_Base::next

(

T *&

)

const

Passes back the {entry} under the iterator. Returns 0 if the iteration has completed, otherwise 1

next() [2/2]

T * ACE_Double_Linked_List_Iterator_Base::next

(

void

)

const

Deprecated:

Return the address of next (current) unvisited item in the list. 0 if there is no more element available.

not_done()

T * ACE_Double_Linked_List_Iterator_Base::not_done ( void  ) const

protected

Check if we reach the end of the list. Can also be used to get the current element in the list. Return the address of the current item if there are still elements left , 0 if we run out of element.

operator*()

T & ACE_Double_Linked_List_Iterator_Base::operator*

(

void

)

const

STL-like iterator dereference operator: returns a reference to the node underneath the iterator.

reset()

void ACE_Double_Linked_List_Iterator_Base::reset

(

ACE_Double_Linked_List< T > &

dll

)

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?

Member Data Documentation

ACE_ALLOC_HOOK_DECLARE

ACE_Double_Linked_List_Iterator_Base::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

current_

T* ACE_Double_Linked_List_Iterator_Base::current_

protected

Remember where we are.

dllist_

const ACE_Double_Linked_List<T>* ACE_Double_Linked_List_Iterator_Base::dllist_

protected

---

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

• Containers.h
• Containers_T.h
• Containers_T.cpp