RWTPtrSortedDlistIterator<T,C,A>

Module:  Essential Tools Module   Group:  STL-based Collection Classes

Does not inherit

• Local Index
• Synopsis
• Description
• Persistence
• Example
• Public Constructors
• Public Member Operators
• Public Member Functions

Members

container() findNext() key()

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

operator--() operator-=() remove()

removeNext() reset() RWTPtrSortedDlistIterator<T,C,A>()

#include<rw/tpsrtdli.h>
RWTPtrSortedDlist<T,C,A> dl;
RWTPtrSortedDlistIterator<T,C,A> itr(dl);

RWTPtrSortedDlistIterator provides the traditional Tools.h++ iterator interface to the standard library-based collections. (An STL iterator interface is provided through RWTPtrSortedDlist::iterator.)

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 will return a value equivalent to boolean false. Continued increments will 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 C++ Standard Library.

None

#include<rw/tpsrtdli.h>
#include<iostream>
#include<rw/cstring.h>
#include<functional>

int main() {
   RWTPtrSortedDlist<RWCString,std::less<RWCString> > a;
   RWTPtrSortedDlistIterator<RWCString,std::less<RWCString> > itr(a);

   a.insert(new RWCString("John"));
   a.insert(new RWCString("Steve"));
   a.insert(new RWCString("Mark"));
   a.insert(new RWCString("Steve"));

   while(itr()) {
     std::cout << *itr.key() << std::endl;
   }

   a.clearAndDestroy();
   return 0;
}

Program Output:

John
Mark
Steve
Steve

RWTPtrSortedDlistIterator<T,C,A>(RWTPtrSortedDlist<T,C,A>& l);

Creates an iterator for the list l. The iterator begins in an undefined state and must be advanced before the first element will be accessible

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, a nil pointer will be returned.

bool
operator++();

Advances self to the next element. If the iterator has been reset or just created self will now reference the first element. If, before iteration, self referenced the last association in the list, self will now point to an undefined value and a value equivalent to false will be 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.

bool
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 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 reference 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

RWTPtrSortedDlist<T,C,A>*
container() const; 

Returns a pointer to the collection being iterated over.

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."

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."

T*
key();

Returns the stored value pointed to by self. Undefined if self is not referencing a value within the list.

T*
remove();

Returns the stored value pointed to by self. and removes it from the collection. Undefined if self is not referencing a value within the list. Leaves self referencing prior item or in reset state.

T*
removeNext(const T*);

Returns and removes the first element t, encountered by iterating self forward, such that the expression (*t == *a) is true. Otherwise returns nil. Leaves self referencing prior item or in reset state.

T*
removeNext(bool(*fn)(T*, void*), void* d);

Returns and 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:

   bool yourTester(const T* a, void* d);

Client data may be passed through parameter d. Otherwise returns nil. Leaves self referencing prior item or in reset state.

void
reset();
void
reset(RWTPtrSortedDlist<T,C,A>& l);

Resets the iterator so that after being advanced it will point to the first element of the collection. Using reset() with no argument will reset the iterator on the current container. Supplying a RWTPtrSortedDlist to reset() will reset the iterator on the new container.

© 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.