rb.iterator Object Description
(iterator Template)

This page summarises the basic set of functionality provided by all iterator objects. Each iterator comprises a set of standard methods (documented here) and a number of data properties (defined by a template data type).

You can think of this as an inheritance mechanism. This page defines a generic base class (i.e. a pure virtual base class - it is never instantiated in it is own right). Templates then inherit this functionality into the iterators that they can return from their methods.

For a full discussion of iterators and how to use them see the Iterator Technical Note.

Methods