RWTIsvDlistIterator<T>

Module:  Essential Tools Module   Group:  Traditional Collection Classes

Does not inherit

• Local Index
• Synopsis
• Description
• Persistence
• Public Constructor
• Public Operators
• Public Member Functions

Members

container() findNext() insertAfterPoint() key()

operator()() operator++() operator+=() operator--()

operator-=() remove() removeNext() reset()

RWTIsvDlistIterator<T>()

#include <rw/tidlist.h>
RWTIsvDlist<T> list;
RWTIsvDlistIterator<T> iterator(list);

Iterator for class RWTIsvDlist<T>, allowing sequential access to all the elements of a doubly-linked parameterized intrusive list. Elements are accessed in order, in either direction.

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.

None

RWTIsvDlistIterator<T>(RWTIsvDlist<T>& c);

Constructs an iterator to be used with the list c.

T*
operator++();

Advances the iterator one position, returning a pointer to the new link, or nil if the end of the list has been reached.

T*
operator--();

Reverses the iterator one position, returning a pointer to the new link, or nil if the beginning of the list has been reached.

T*
operator+=(size_t n);

Advances the iterator n positions, returning a pointer to the new link, or nil if the end of the list has been reached.

T*
operator-=(size_t n);

Reverses the iterator n positions, returning a pointer to the new link, or nil if the beginning of the list has been reached.

T*
operator()();

Advances the iterator one position, returning a pointer to the new link, or nil if the end of the list has been reached.

RWTIsvDlist<T>*
container() const;

Returns a pointer to the collection over which this iterator is iterating.

T*
findNext(bool (*testFun)(const T*, void*),void*);

Advances the iterator to the first link for which the tester function pointed to by testFun returns true and returns it, or nil if there is no such link.

void
insertAfterPoint(T* a) ;

Inserts the link pointed to by a into the iterator's associated collection in the position immediately after the iterator's current position.

T*
key() const;

Returns the link at the iterator's current position. Returns nil if the iterator is not valid.

T*
remove();

Removes and returns the current link from the iterator's associated collection. Returns nil if unsuccessful. Afterwards, if successful, the iterator will be positioned at the element immediately before the removed link.

T*
removeNext(bool (*testFun)(const T*, void*),void*);

Advances the iterator to the first link for which the tester function pointed to by testFun returns true, removes and returns it. Returns false if unsuccessful. Afterwards, if successful, the iterator will be positioned at the element immediately before the removed element.

void
reset();

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

void
reset(RWTIsvDlist<TL>& c);

Resets the iterator to iterate over the collection c.

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.