RWTValDlistIterator<T,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() RWTValDlistIterator<T,A>()

#include<rw/tvdlist.h>
RWTValDlist<T,A> dl;
RWTValDlistIterator<T,A> itr(dl);

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

The order of iteration over an RWTValDlist is dependent on the order of insertion of the values into 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 equal to false until reset() is called.

None

#include<rw/tvdlist.h>
#include<iostream>
#include<rw/cstring.h>
int main() {
   RWTValDlist<RWCString> a;
   RWTValDlistIterator<RWCString> itr(a);

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

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

   return 0;
}

Program Output:

John
Steve
Mark
Steve

RWTValDlistIterator<T,A>(RWTValDlist<T,A>& s); 

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

bool
operator()();

Advances self to the next element 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 reference the first element. If, before iteration, self referenced the last value in the list, self will now reference an undefined value distinct from the reset value and false will be returned. Otherwise, true is returned. Note: no postincrement operator is provided.

bool
operator+=(size_type n); 

Behaves as if the operator++ member function 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 postdecrement operator is provided.

bool
operator-=(size_type n); 

Behaves as if the operator-- member function had been applied n times.

RWTValDlist<T,A>*
container() const; 

Returns a pointer to the collection being iterated over.

bool
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 an element was found, returns false otherwise.

bool
findNext(bool(*fn)(const 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 an element was found, returns false otherwise.

T&
key();

Returns a reference to the stored value.

bool
remove();

Removes the value referenced by self from the collection. true is returned if the removal is successful, false is returned otherwise.

bool
removeNext(const T); 

Removes the first element t, encountered by iterating self forward, such that the expression (t == a) is true. Returns true if an element was found and removed, returns false otherwise.

bool
removeNext(bool(*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:

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

Client data may be passed through parameter d. Returns true if an element was found and removed, returns false otherwise.

void
reset();
void
reset(RWTValDlist<T,A>& 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 RWTValDlist 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.