RWTValSortedDlistIterator(3C++) RWTValSortedDlistIterator(3C++)
Name
RWTValSortedDlistIterator<T,C> - Rogue Wave library class
Synopsis
#include<rw/tvsrtdli.h>
RWTValSortedDlist<T,C> dl;
RWTValSortedDlistIterator<T,C> itr(dl);
Standard C++ Library Dependent!RWTValSortedDlistIterator requires the Standard C++ Library.
DescriptionRWTValSortedDlistIterator is supplied with Tools.h++ 7 to provide an
iterator interface to RWTValSortedDlistIterator that is backward
compatable with the container iterators provided in Tools.h++ 6.x. The
order of iteration over an RWTValSortedDlist is dependent on the supplied
comparator object supplied 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 will
return a value equivalent to boolean false. Continued increments will
return a value equivalent to false until reset() is called.
Persistence
None
Examples
#include<rw/tvsrtdli.h>
#include<iostream.h>
#include<rw/cstring.h>
int main(){
RWTValSortedDlist<RWCString, less<RWCString> > a;
RWTValSortedDlistIterator<RWCString, less<RWCString> > itr(a);
Page 1
RWTValSortedDlistIterator(3C++) RWTValSortedDlistIterator(3C++)
a.insert("John");
a.insert("Steve");
a.insert("Mark");
a.insert("Steve");
for(;itr();)
cout << itr.key() << endl;
return 0;
}
Program Output
John
Mark
Steve
Steve
Public Constructors
RWTValSortedDlistIterator<T,C>(RWTValSortedDlist<T,C>&s);
Creates an iterator for the sorted dlist s. The iterator begins in an
undefined state and must be advanced before the first element will be
accessible.
Public Member Operators
RWBoolean
operator()();
Advances self to the next element. If the iterator has advanced past the
Page 2
RWTValSortedDlistIterator(3C++) RWTValSortedDlistIterator(3C++)
last item in the container, the element returned will be a nil pointer
equivalent to boolean false.
RWBoolean
operator++();
Advances self to the next element. If the iterator has been reset or
just created, self will reference the first element. If, before
iteration, self referenced the last value in the list, self will now
point to an undefined value distinct from the reset value and false will
be returned. Otherwise, true is returned. Note: no postincrement
operator is provided.
RWBoolean
operator+=(size_type n);
Behaves as if the operator++ member function had been applied n times
RWBoolean
operator--();
Moves self back to the immediately previous element. If the iterator has
been reset or just created, this operator will return false, otherwise it
will return true. If self references the the first element, it will now
be in the reset state. If self has been iterated past the last value in
the list, it will now point to the last item in the list. Note: no
postdecrement operator is provided.
RWBoolean
operator-=(size_type n);
Behaves as if the operator-- member function had been applied n times
Public Member Functions
RWTValSortedDlist<T,C>*
container() const;
Returns a pointer to the collection being iterated over.
RWBoolean
findNext(const T a);
Advances self to the first element t encountered by iterating forward,
such that the expression (t == a) is true. Returns true if such an
element if found, false otherwise.
Page 3
RWTValSortedDlistIterator(3C++) RWTValSortedDlistIterator(3C++)
RWBoolean
findNext(RWBoolean(*fn)(T, void*), void* d);
Advances self to the first element t encountered by iterating 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. Returns true if such an
element if found, false otherwise.
T
key();
Returns the stored value referenced by self.
RWBoolean
remove();
Removes the stored value referenced by self from the collection. Returns
true if the value was successfully removed, false otherwise.
RWBoolean
removeNext(const T);
Removes the first element t, encountered by iterating self forward, such
that the expression (t == a) is true. Returns true if such an element is
successfully removed, false otherwise.
RWBoolean
removeNext(RWBoolean(*fn)(T, void*), void* d);
Removes 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:
Page 4
RWTValSortedDlistIterator(3C++) RWTValSortedDlistIterator(3C++)
bool yourTester(const T a, void* d);
Client data may be passed through parameter d. Returns true if such an
element is successfully removed, false otherwise.
void
reset();
void
reset(RWTValSortedDlist<T,C>& l);
Resets the iterator so that after being advanced it will reference the
first element of the collection. Using reset() with no argument will
reset the iterator on the current container. Supplying a
RWTValSortedDlist to reset() will reset the iterator on the new
container.
Page 5
