ACE  6.5.11
Public Member Functions | Public Attributes | Private Attributes | List of all members
ACE_Array_Iterator Class Reference

Implement an iterator over an ACE_Array. More...

#include <Array_Base.h>

Public Member Functions

 ACE_Array_Iterator (ACE_Array_Base< T > &)
 
int next (T *&next_item)
 
int advance (void)
 
int done (void) const
 Returns 1 when all items have been seen, else 0. More...
 
void dump (void) const
 Dump the state of an object. More...
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 

Private Attributes

size_t current_
 Pointer to the current item in the iteration. More...
 
ACE_Array_Base< T > & array_
 Pointer to the Array we're iterating over. More...
 

Detailed Description

Implement an iterator over an ACE_Array.

This iterator is safe in the face of array element deletions. But it is NOT safe if the array is resized (via the ACE_Array assignment operator) during iteration. That would be very odd, and dangerous.

Constructor & Destructor Documentation

◆ ACE_Array_Iterator()

ACE_Array_Iterator::ACE_Array_Iterator ( ACE_Array_Base< T > &  a)
inline

Member Function Documentation

◆ advance()

int ACE_Array_Iterator::advance ( void  )
inline

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

◆ done()

int ACE_Array_Iterator::done ( void  ) const
inline

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

◆ dump()

void ACE_Array_Iterator::dump ( void  ) const
inline

Dump the state of an object.

◆ next()

int ACE_Array_Iterator::next ( T *&  next_item)

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

Member Data Documentation

◆ ACE_ALLOC_HOOK_DECLARE

ACE_Array_Iterator::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

◆ array_

ACE_Array_Base<T>& ACE_Array_Iterator::array_
private

Pointer to the Array we're iterating over.

◆ current_

size_t ACE_Array_Iterator::current_
private

Pointer to the current item in the iteration.


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