ACE_Ordered_MultiSet_Iterator Class Reference

Implement a bidirectional iterator over an ordered multiset. This class template requires that < operator semantics be defined for the parameterized type {T}, but does not impose any restriction on how that ordering operator is implemented. More...

#include <Containers_T.h>

Collaboration diagram for ACE_Ordered_MultiSet_Iterator:

List of all members.

Public Member Functions
	ACE_Ordered_MultiSet_Iterator (ACE_Ordered_MultiSet< T > &s)
int	next (T *&next_item) const
int	first (void)
int	last (void)
int	advance (void)
int	retreat (void)
int	done (void) const
	Returns 1 when all items have been seen, else 0.
void	dump (void) const
	Dump the state of an object.
T &	operator* (void)
	Returns a reference to the internal element {this} is pointing to.
Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Private Attributes
ACE_DNode< T > *	current_
	Pointer to the current node in the iteration.
ACE_Ordered_MultiSet< T > &	set_
	Pointer to the set we're iterating over.
Friends
class	ACE_Ordered_MultiSet< T >

---

Detailed Description

Implement a bidirectional iterator over an ordered multiset. This class template requires that < operator semantics be defined for the parameterized type {T}, but does not impose any restriction on how that ordering operator is implemented.

---

Constructor & Destructor Documentation

ACE_Ordered_MultiSet_Iterator::ACE_Ordered_MultiSet_Iterator

(

ACE_Ordered_MultiSet< T > &

s

)

---

Member Function Documentation

int ACE_Ordered_MultiSet_Iterator::advance

(

void

)

[inline]

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

int ACE_Ordered_MultiSet_Iterator::done

(

void

)

const [inline]

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

void ACE_Ordered_MultiSet_Iterator::dump

(

void

)

const [inline]

Dump the state of an object.

int ACE_Ordered_MultiSet_Iterator::first

(

void

)

[inline]

Repositions the iterator at the first item in the ordered multiset Returns 0 if the list is empty else 1.

int ACE_Ordered_MultiSet_Iterator::last

(

void

)

[inline]

Repositions the iterator at the last item in the ordered multiset Returns 0 if the list is empty else 1.

int ACE_Ordered_MultiSet_Iterator::next

(

T *&

next_item

)

const

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

T & ACE_Ordered_MultiSet_Iterator::operator*

(

void

)

Returns a reference to the internal element {this} is pointing to.

int ACE_Ordered_MultiSet_Iterator::retreat

(

void

)

[inline]

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

---

Friends And Related Function Documentation

friend class ACE_Ordered_MultiSet< T > [friend]

---

Member Data Documentation

ACE_Ordered_MultiSet_Iterator::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

ACE_DNode<T>* ACE_Ordered_MultiSet_Iterator::current_ [private]

Pointer to the current node in the iteration.

ACE_Ordered_MultiSet<T>& ACE_Ordered_MultiSet_Iterator::set_ [private]

Pointer to the set we're iterating over.

---

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

• Containers_T.h
• Containers_T.cpp
• Containers_T.inl