mxmMutableBidirectionalIteratorInterface Class Reference
[modularMX Runtime Platform Core]

Interface for all classes that maintain items one can iterate over in both forward and backward directions, but that also offer the possibility to modify their contents arrangement via the iterator. More...

#include <mxmMutableBidirectionalIteratorInterface.h>

Inheritance diagram for mxmMutableBidirectionalIteratorInterface:

mxmBidirectionalIteratorInterface mxmIteratorInterface mxmInterface mxmList::Iterator mxmPerlStyleHash::Iterator List of all members.

Public Member Functions

virtual mxmObjectremoveCurrentItem (void)=0
 Removes and returns the item currently pointed to by the iterator.

Detailed Description

Interface for all classes that maintain items one can iterate over in both forward and backward directions, but that also offer the possibility to modify their contents arrangement via the iterator.

Author:
[khe] Kai Hergenroether


Member Function Documentation

virtual mxmObject* mxmMutableBidirectionalIteratorInterface::removeCurrentItem void   )  [pure virtual]
 

Removes and returns the item currently pointed to by the iterator.

Ownership over the item is transferred to the calling context. The container iterated over is no longer responsible for deleting the item later.

If the iterator has just been reset, or if the iteration has already been completed, 0 is returned.

After the current item has been removed, the iteration can be continued in forward direction. Continuation of the iteration after multiple consecutive calls to removeCurrentItem() however is undefined, yet it will not corrupt the container's state.

Implemented in mxmList::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