Module: Essential Tools Module Group: STL-based Collection
Does not inherit
#include <rw/tpsrtdli.h> template <class T, class C, class A=std::allocator<T*> > class RWTPtrSortedDlistConstIterator
RWTPtrSortedDlistConstIterator provides a const iterator interface to Standard Library-based RWTPtrSortedDlist collections. A const iterator does not modify anything in the underlying collection.
The order of iteration over an RWTPtrSortedDlist is dependent on the comparator object parameter C as applied to the values stored in the container.
The current item referenced by this iterator is undefined after construction or after a call to reset(). The iterator becomes valid after being advanced with either a preincrement or operator().
For both operator++ and operator(), iterating past the last element returns a value equivalent to boolean false. Continued increments return a value equivalent to false until reset() is called.
The value type must have operator== and operator< defined. This requirement is imposed by the Standard C++ Library.
Creates a const iterator for the list l. The iterator begins in an undefined state and must be advanced before the first element is accessible
const T* operator()();
Advances self to the next element, dereferences the resulting iterator and returns its value. If the iterator has advanced past the last item in the container, the element returned is a nil pointer equivalent to boolean false.
Advances self to the next element. If the iterator has been reset or just created self now references the first element. If, before iteration, self referenced the last association in the list, self now points to an undefined value and a value equivalent to false is returned. Otherwise, a value equivalent to true is returned. Note: no post-increment operator is provided.
bool operator+=(size_type n);
Behaves as if operator++() had been applied n times.
Moves self back to the immediately previous element. If the iterator has been reset or just created, this operator returns false, otherwise it returns true. If self references the first element, it is now in the reset state. If self has been iterated past the last value in the list, it now references the last item in the list. Note: no post-decrement operator is provided.
bool operator-=(size_type n);
Behaves as if operator--() had been applied n times
const RWTPtrSortedDlist<T,C,A>* container() const;
Returns a pointer to the collection being iterated over.
const T* findNext(const T* a);
Returns the first element t encountered by iterating self forward, such that the expression (*t == *a) is true. Otherwise returns nil. Leaves self-referencing found item or "off the end."
const T* findNext(bool(*fn)(T*, void*), void* d);
Returns the first element t encountered by iterating self forward such that the expression((*fn)(t,d)) is true. fn points to a user-defined tester function which must have prototype:
bool yourTester(const T* a, void* d);
Client data may be passed through parameter d. Otherwise returns nil. Leaves self referencing found item or "off the end."
const T* key();
Returns the stored value pointed to by self. Undefined if self is not referencing a value within the list.
void reset(); void reset(RWTPtrSortedDlist<T,C,A>& l);
Resets the iterator so that after being advanced it points to the first element of the collection. Using reset() with no argument resets the iterator on the current container. Supplying a RWTPtrSortedDlist to reset() resets the iterator on the new container.
©2004 Copyright Quovadx, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Quovadx, 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.