RWDlistCollectablesConstIterator Class Reference

Traverses the linked-list from the first (head) to the last (tail) item. More...

#include <rw/dlistcol.h>

Inheritance diagram for RWDlistCollectablesConstIterator:

Public Member Functions
	RWDlistCollectablesConstIterator (const RWDlistCollectables &s)
	RWDlistCollectablesConstIterator (const RWDlistCollectablesIterator &it)
virtual const RWCollectable *	findNext (const RWCollectable *target)
const RWCollectable *	findNextReference (const RWCollectable *e)
virtual const RWCollectable *	key () const
virtual const RWCollectable *	operator() ()
virtual void	reset ()

Detailed Description

One of two iterators for class RWDlistCollectables. As a const iterator, this iterator does not contain any functions that change the data structure it is iterating through.

This iterator traverses the linked-list from the first (head) to the last (tail) item. Functions are provided for moving in either direction.

As with all Rogue Wave iterators, the "current item" is undefined immediately after construction – you must define it by using operator()() or some other (valid) operation.

Once the iterator has advanced beyond the end of the collection it is no longer valid – continuing to use it brings undefined results.

Synopsis

#include <rw/dlistcol.h>
RWDlistCollectables d;
RWDlistCollectablesConstIterator it(d);

Persistence

None

Constructor & Destructor Documentation

RWDlistCollectablesConstIterator::RWDlistCollectablesConstIterator ( const RWDlistCollectables &  s )

inline

Constructs an RWDlistCollectablesConstIterator from an RWDlistCollectables. Immediately after construction, the position of the iterator is undefined.

RWDlistCollectablesConstIterator::RWDlistCollectablesConstIterator ( const RWDlistCollectablesIterator &  it )

inline

Constructs an RWDlistCollectablesConstIterator from an RWDlistCollectablesIterator. Immediately after construction, the position of the iterator is undefined.

Member Function Documentation

virtual const RWCollectable* RWDlistCollectablesConstIterator::findNext ( const RWCollectable *  target )

inlinevirtual

Moves the iterator to the next item which isEqual() to the item pointed to by target and returns it. If no item is found, the function returns rwnil and the position of the iterator is undefined.

Implements RWConstIterator.

const RWCollectable* RWDlistCollectablesConstIterator::findNextReference ( const RWCollectable *  e )

inline

Moves the iterator to the next item that is identical to the item pointed to by e (that is, that has address e) and returns it. If no item is found, the function returns rwnil and the position of the iterator is undefined.

virtual const RWCollectable* RWDlistCollectablesConstIterator::key ( ) const

inlinevirtual

Returns the item at the current iterator position.

Implements RWConstIterator.

virtual const RWCollectable* RWDlistCollectablesConstIterator::operator() ( )

inlinevirtual

Advances the iterator and returns the next item, or rwnil if the end of the collection has been reached.

Implements RWConstIterator.

virtual void RWDlistCollectablesConstIterator::reset ( )

inlinevirtual

Resets the iterator. Afterwards, the position of the iterator is undefined.

Implements RWConstIterator.