CopperSpice API  1.7.2
QSetIterator< T > Class Template Reference

The QSetIterator class provides a Java style const iterator for QSet. More...

Public Methods

 QSetIterator (const QSet< T > &set)
 
bool findNext (const T &value)
 
bool findPrevious (const T &value)
 
bool hasNext () const
 
bool hasPrevious () const
 
const T & next ()
 
QSetIterator & operator= (const QSet< T > &set)
 
const T & peekNext () const
 
const T & peekPrevious () const
 
const T & previous ()
 
void toBack ()
 
void toFront ()
 

Detailed Description

template<class T>
class QSetIterator< T >

The QSetIterator class provides a Java style const iterator for QSet. For more information refer to Java style iterators.

See also
QMutableSetIterator, QSet::const_iterator

Constructor & Destructor Documentation

template<class T >
QSetIterator< T >::QSetIterator ( const QSet< T > &  set)
inline

Constructs an iterator for traversing set. The iterator is set to be at the front of the set (before the first item).

See also
operator=()

Method Documentation

template<class T >
bool QSetIterator< T >::findNext ( const T &  value)
inline

Searches for value starting from the current iterator position forward. Returns true if value is found, otherwise returns false.

After the call, if value was found, the iterator is positioned just after the matching item, otherwise the iterator is positioned at the back of the container.

template<class T >
bool QSetIterator< T >::findPrevious ( const T &  value)
inline

Searches for value starting from the current iterator position backward. Returns true if value is found, otherwise returns false.

After the call, if value was found, the iterator is positioned just before the matching item, otherwise the iterator is positioned at the front of the container.

template<class T >
bool QSetIterator< T >::hasNext ( ) const
inline

Returns true if there is at least one item ahead of the iterator. This occurs when the iterator is not at the end of the container.

See also
next()
template<class T >
bool QSetIterator< T >::hasPrevious ( ) const
inline

Returns true if there is at least one item before the iterator. This occurs when the iterator is not at the beginning of the container.

See also
next()
template<class T >
const T & QSetIterator< T >::next ( )
inline

Returns the next item and advances the iterator by one position.

Calling this function on an iterator located at the back of the container leads to undefined behavior.

See also
hasNext(), peekNext()
template<class T >
QSetIterator & QSetIterator< T >::operator= ( const QSet< T > &  set)
inline

Makes the iterator operate on set. The iterator is set to be at the front of the set (before the first item).

See also
toFront(), toBack()
template<class T >
const T & QSetIterator< T >::peekNext ( ) const
inline

Returns the next item without moving the iterator.

Calling this function on an iterator located at the back of the container leads to undefined behavior.

See also
hasNext(), next()
template<class T >
const T & QSetIterator< T >::peekPrevious ( ) const
inline

Returns the previous item without moving the iterator.

Calling this function on an iterator located at the front of the container leads to undefined results.

See also
hasPrevious(), previous(), peekNext()
template<class T >
const T & QSetIterator< T >::previous ( )
inline

Returns the previous item and moves the iterator back by one position.

Calling this function on an iterator located at the front of the container leads to undefined results.

See also
hasPrevious(), peekPrevious(), next()
template<class T >
void QSetIterator< T >::toBack ( )
inline

Moves the iterator to the back of the container (after the last item).

See also
toFront()
template<class T >
void QSetIterator< T >::toFront ( )
inline

Moves the iterator to the front of the container (before the first item).

See also
toBack(), next()