ACE  7.0.2
Public Member Functions | Public Attributes | Private Attributes | Friends | List of all members
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:
Collaboration graph
[legend]

Public Member Functions

 ACE_Ordered_MultiSet_Iterator (ACE_Ordered_MultiSet< T > &s)
 
int next (T *&next_item) const
 
int first ()
 
int last ()
 
int advance ()
 
int retreat ()
 
int done () const
 Returns 1 when all items have been seen, else 0. More...
 
void dump () const
 Dump the state of an object. More...
 
T & operator* ()
 Returns a reference to the internal element {this} is pointing to. More...
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 

Private Attributes

ACE_DNode< T > * current_
 Pointer to the current node in the iteration. More...
 
ACE_Ordered_MultiSet< T > & set_
 Pointer to the set we're iterating over. More...
 

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_Iterator ( ACE_Ordered_MultiSet< T > &  s)

Member Function Documentation

◆ advance()

int ACE_Ordered_MultiSet_Iterator::advance ( )
inline

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

◆ done()

int ACE_Ordered_MultiSet_Iterator::done ( ) const
inline

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

◆ dump()

void ACE_Ordered_MultiSet_Iterator::dump ( ) const
inline

Dump the state of an object.

◆ first()

int ACE_Ordered_MultiSet_Iterator::first ( )
inline

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

◆ last()

int ACE_Ordered_MultiSet_Iterator::last ( )
inline

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

◆ next()

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.

◆ operator*()

T & ACE_Ordered_MultiSet_Iterator::operator* ( )

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

◆ retreat()

int ACE_Ordered_MultiSet_Iterator::retreat ( )
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

◆ ACE_Ordered_MultiSet< T >

friend class ACE_Ordered_MultiSet< T >
friend

Member Data Documentation

◆ ACE_ALLOC_HOOK_DECLARE

ACE_Ordered_MultiSet_Iterator::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

◆ current_

ACE_DNode<T>* ACE_Ordered_MultiSet_Iterator::current_
private

Pointer to the current node in the iteration.

◆ set_

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: