RWBinaryTreeConstIterator Class Reference
[RWCollectable-derived]

Iterator for class RWBinaryTree that allows no changes to the values in the binary tree. More...

#include <rw/bintree.h>

Inheritance diagram for RWBinaryTreeConstIterator:

List of all members.

Public Member Functions
	RWBinaryTreeConstIterator (const RWBinaryTree &)
	RWBinaryTreeConstIterator (const RWBinaryTreeIterator &it)
virtual const RWCollectable *	findNext (const RWCollectable *target)
virtual const RWCollectable *	key () const
virtual const RWCollectable *	operator() ()
virtual void	reset ()

---

Detailed Description

Provides a const iterator for class RWBinaryTree. Traverses the tree from the smallest to the largest element, where "smallest" and "largest" are defined by the virtual function RWBinaryTree::compareTo(). Note that this approach is generally less efficient than using the member function RWBinaryTree::apply().

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 leads to undefined results.

Synopsis

 #include <rw/bintree.h>
 RWBinaryTree bt;
 RWBinaryTreeConstIterator iterate(bt);

Persistence

None

---

Constructor & Destructor Documentation

RWBinaryTreeConstIterator::RWBinaryTreeConstIterator

(

const RWBinaryTree &

)

Constructs a const iterator for an RWBinaryTree. Immediately after construction, the position of the iterator is undefined until positioned.

RWBinaryTreeConstIterator::RWBinaryTreeConstIterator

(

const RWBinaryTreeIterator &

it

)

[inline]

Constructs a const iterator from an iterator. Immediately after construction, the position of the const iterator is undefined until positioned.

---

Member Function Documentation

virtual const RWCollectable* RWBinaryTreeConstIterator::findNext

(

const RWCollectable *

target

)

[virtual]

Moves iterator to the next item that compares equal to the object pointed to by target and returns it. If no item is found, returns rwnil and the position of the iterator is undefined.

Implements RWConstIterator.

virtual const RWCollectable* RWBinaryTreeConstIterator::key

(

)

const [virtual]

Returns the item at the current iterator position.

Implements RWConstIterator.

virtual const RWCollectable* RWBinaryTreeConstIterator::operator()

(

)

[virtual]

Advances iterator to the next largest element and returns a pointer to it. Returns rwnil when the end of the collection is reached.

Implements RWConstIterator.

virtual void RWBinaryTreeConstIterator::reset

(

)

[virtual]

Resets the iterator to the state it had immediately after construction.

Implements RWConstIterator.