ACE_DLList_Iterator< T > Class Template Reference

A double-linked list container class iterator. More...

#include <Containers_T.h>

Inheritance diagram for ACE_DLList_Iterator< T >:

Collaboration diagram for ACE_DLList_Iterator< T >:

List of all members.

Public Member Functions
	ACE_DLList_Iterator (ACE_DLList< T > &l)
void	reset (ACE_DLList< T > &l)
int	advance (void)
int	next (T *&)
T *	next (void) const
int	remove (void)
void	dump (void) const
	Delegates to ACE_Double_Linked_List_Iterator.
Private Attributes
ACE_DLList< T > *	list_
Friends
class	ACE_DLList< T >
class	ACE_DLList_Node

---

Detailed Description

template<class T>
class ACE_DLList_Iterator< T >

A double-linked list container class iterator.

This implementation uses ACE_Double_Linked_List_Iterator to perform the logic behind this container class. It delegates all of its calls to ACE_Double_Linked_List_Iterator.

Definition at line 1136 of file Containers_T.h.

---

Constructor & Destructor Documentation

template<class T >

ACE_DLList_Iterator< T >::ACE_DLList_Iterator

(

ACE_DLList< T > &

l

)

[inline]

Definition at line 379 of file Containers_T.inl.

  : ACE_Double_Linked_List_Iterator <ACE_DLList_Node> ((ACE_DLList_Base &)l),
    list_ (&l)
{
}

---

Member Function Documentation

template<class T >

int ACE_DLList_Iterator< T >::advance

(

void

)

[inline]

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

Reimplemented from ACE_Double_Linked_List_Iterator< ACE_DLList_Node >.

Definition at line 410 of file Containers_T.inl.

{
  return this->ACE_Double_Linked_List_Iterator <ACE_DLList_Node>::advance ();
}

template<class T >

void ACE_DLList_Iterator< T >::dump

(

void

)

const [inline]

Delegates to ACE_Double_Linked_List_Iterator.

Reimplemented from ACE_Double_Linked_List_Iterator< ACE_DLList_Node >.

Definition at line 416 of file Containers_T.inl.

{
#if defined (ACE_HAS_DUMP)
  ACE_Double_Linked_List_Iterator <ACE_DLList_Node>::dump ();
#endif /* ACE_HAS_DUMP */
}

template<class T >

T * ACE_DLList_Iterator< T >::next

(

void

)

const [inline]

Deprecated:

Delegates to ACE_Double_Linked_List_Iterator, except that whereas the Double_Linked_List version of next returns the node, this next returns the contents of the node

Reimplemented from ACE_Double_Linked_List_Iterator_Base< ACE_DLList_Node >.

Definition at line 403 of file Containers_T.inl.

{
  ACE_DLList_Node *temp = ACE_Double_Linked_List_Iterator <ACE_DLList_Node>::next ();
  return (T *) (temp ? temp->item_ : 0);
}

template<class T >

int ACE_DLList_Iterator< T >::next

(

T *&

ptr

)

[inline]

Pass back the {next_item} that hasn't been seen in the list. Returns 0 when all items have been seen, else 1.

Definition at line 393 of file Containers_T.inl.

{
  ACE_DLList_Node *temp =
    ACE_Double_Linked_List_Iterator <ACE_DLList_Node>::next ();
  if (temp)
    ptr = (T *) temp->item_;
  return temp ? 1 : 0;
}

template<class T >

int ACE_DLList_Iterator< T >::remove

(

void

)

[inline]

Removes the current item (i.e., {next}) from the list. Note that DLList iterators do not support {advance_and_remove} directly (defined in its base class) and you will need to release the element returned by it.

Definition at line 371 of file Containers_T.inl.

{
  ACE_DLList_Node *temp = this->ACE_Double_Linked_List_Iterator <ACE_DLList_Node>::next ();
  this->ACE_Double_Linked_List_Iterator <ACE_DLList_Node>::advance ();
  return list_->remove (temp);
}

template<class T >

void ACE_DLList_Iterator< T >::reset

(

ACE_DLList< T > &

l

)

[inline]

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?

Definition at line 386 of file Containers_T.inl.

{
  list_ = &l;
  this->ACE_Double_Linked_List_Iterator <ACE_DLList_Node>::reset ((ACE_DLList_Base &)l);
}

---

Friends And Related Function Documentation

template<class T >

friend class ACE_DLList< T > [friend]

Definition at line 1139 of file Containers_T.h.

template<class T >

friend class ACE_DLList_Node [friend]

Definition at line 1140 of file Containers_T.h.

---

Member Data Documentation

template<class T >

ACE_DLList<T>* ACE_DLList_Iterator< T >::list_ [private]

Definition at line 1186 of file Containers_T.h.

---

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

• Containers_T.h
• Containers_T.inl