Tools.h++ Manual

104011 Tandem Computers Incorporated 22-45
22
RWTPtrHashTableIterator<T>
Synopsis #include <rw/tphasht.h>
RWTPtrHashTable<T> table;
RWTPtrHashTableIterator<T> iterator(table);
Description Iterator for class RWTPtrHashTable<T> , allowing sequential access to all the
elements of a hash table. Elements are not accessed in any particular order.
Like all Tools.h++ 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.
Public constructor RWTPtrHashTableIterator(RWTPtrHashTable<T>& c);
Constructs an iterator to be used with the table c .
Public operators RWBoolean operator++();
Advances the iterator to the next item and returns TRUE . When the end of the
collection is reached, returns FALSE and the position of the iterator will be
undefined.
T* operator()();
Advances the iterator to the next item and returns a pointer to it. When the
end of the collection is reached, returns nil and the position of the iterator will
be undefined.
Public member functions RWTPtrHashTable<T>* container() const;
Returns a pointer to the collection over which this iterator is iterating.
T* key() const
Returns a pointer to the item at the iterator's current position. The results are
undefined if the iterator is no longer valid.