RWTPtrDlistConstIterator<T,A>

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

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

Members

container() findNext() key()

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

operator--() operator-=() reset()

RWTPtrDlistConstIterator<T,A>()

#include <rw/tpdlist.h>
template <class T, class A=std::allocator<T*> >
class  RWTPtrDlistConstIterator

RWTPtrDlistConstIterator provides a const iterator interface to the C++ Standard Library-based collections. This iterator prohibits any changes to the underlying collection.

The order of iteration over an RWTPtrDlist is dependent on the order of the values 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 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. For operator--, decrementing past the first element returns a value equivalent to false.

None

RWTPtrDlistConstIterator<T,A>(RWTPtrDlist<T,A>& l); 

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.

bool
operator++();

Advances self to the next element. If the iterator has been reset or just created, self references the first element. If, before iteration, self referenced the last value in the list, self now references an undefined value distinct from the reset 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

bool
operator--();

Moves self back to the immediately previous element. If the iterator has been reset or just created, this operator returns a value equivalent to false, otherwise it returns a value equivalent to 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 RWTPtrDlist<T,A>*
container() const; 

Returns a pointer to the collection being iterated over.

const T*
findNext(const T* a); 

Returns the first element t encountered while iterating self forward, such that the expression (*t == *a) is true. If no such element exists, returns a nil pointer equivalent to false. Leaves self referencing the found item, or "past 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. If no such element exists, returns a nil pointer equivalent to false. Leaves self referencing the found item, or "past the end."

const T*
key();

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

void
reset();
void
reset(const RWTPtrDlist<T,A>& l*);

Resets the iterator so that after being advanced it references the first element of the collection. Using reset with no argument resets the iterator on the current container. Supplying RWTPtrDlist<T,A> to reset() resets 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.