RWBagIterator(3C++)

Name
     RWBagIterator - Rogue Wave library class

Synopsis
              #include <rw/rwbag.h>



              RWBag b;
          RWBagIterator it(b);



Description
     Iterator for class RWBag, which allows sequential access to all the
     elements of RWBag.  Note that because an RWBag is unordered, elements are
     not accessed in any particular order.  If an item was inserted N times
     into the collection, then it will be visited N consecutive times.  Like
     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
              RWBagIterator(const RWBag&);


     Construct an iterator for an RWBag.  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 has been
     reached.

Public Member Functions
              virtual RWCollectable*
          findNext(const RWCollectable* target);


     Redefined from class RWIterator.  Moves iterator to the next item which
     isEqual to the object pointed to by target and returns it.  Hashing is
     used to find the target.  If no item is found, returns nil and the
     position of the iterator will be undefined.
              virtual RWCollectable*
          key() const;


     Redefined from class RWIterator.  Returns the item at the current
     iterator position.

              virtual void
          reset();


     Redefined from class RWIterator.  Resets the iterator to its starting
     state.