RWHashTableIterator(3C++) RWHashTableIterator(3C++)
NameRWHashTableIterator - Rogue Wave library class
Synopsis
#include <rw/hashtab.h>
RWHashTable h;
RWHashTableIteratorit(h);
Description
Iterator for class RWHashTable, which allows sequential access to all the
elements of RWHashTable. Note that because an RWHashTable is unordered,
elements are not accessed in any particular order. 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 will bring
undefined results.
Persistence
None
Public Constructor
RWHashTableIterator(RWHashTable&);
Construct an iterator for an RWHashTable. After construction, the
position of the iterator is undefined.
Public Member Operator
virtual RWCollectable*
operator()();
Redefined from class RWIterator. Advances the iterator to the next item
and returns it. Returns nil when the end of the collection is reached.
Public Member Functions
virtual RWCollectable*
findNext(const RWCollectable* target);
Redefined from class RWIterator. Moves iterator to the next item which
isEqual to the item pointed to by target and returns it.
Page 1
RWHashTableIterator(3C++) RWHashTableIterator(3C++)
virtual RWCollectable*
key() const;
Redefined from class RWIterator. Returns the item at the current
iterator position.
RWCollectable*
remove();
Remove the item at the current iterator position from the collection.
RWCollectable*
removeNext(const RWCollectable*);
Moves the iterator to the next item which isEqual to the item pointed to
by target, removes it from the collection and returns it. If no item is
found, returns nil and the position of the iterator will be undefined.
virtual void
reset();
Redefined from class RWIterator. Resets the iterator to its starting
state.
Page 2
