mxmIteratorInterface Class Reference
[modularMX Runtime Platform Core]

Interface to entities that allow you to iterate over the items of an mxmContainer. More...

#include <mxmIteratorInterface.h>

Inheritance diagram for mxmIteratorInterface:

mxmInterface mxmBidirectionalIteratorInterface mxmMutableIteratorInterface mxmMutableBidirectionalIteratorInterface mxmList::Iterator mxmPerlStyleHash::Iterator List of all members.

Public Member Functions

virtual void resetIterator (void)=0
 Resets the iterator.
virtual mxmObjectnextItem (void)=0
 Retrieves the next item for the current iteration sweep.

Detailed Description

Interface to entities that allow you to iterate over the items of an mxmContainer.

You obtain an iterator for a specific mxmContainer by calling its iterator() method, such as for example mxmList::iterator(). Such an iterator is external to the container, and you can instantiate multiple iterators for a given container if you know what you're doing.

In contrast to the aforementioned external iterators, early modularMX library versions featured containers with inbuilt iterators. However, these inbuilt iterators turned out to be a fundamental design flaw and have consequently been purged from the library.

Author:
[khe] Kai Hergenroether


Member Function Documentation

virtual mxmObject* mxmIteratorInterface::nextItem void   )  [pure virtual]
 

Retrieves the next item for the current iteration sweep.

Returns 0 if there are no more items and the iteration has, as a result, been completed. Once the current iteration has completed, nextItem() will return 0 until the iterator is reset.

Implemented in mxmList::Iterator, and mxmPerlStyleHash::Iterator.


The documentation for this class was generated from the following file:
Generated on Fri Jun 29 17:21:04 2007 for MxPEG SDK by  doxygen 1.4.6