CopperSpice API  2.0.0
Public Methods | List of all members
QMutableSetIterator< T > Class Template Reference
CsCore

The QMutableSetIterator class provides a Java style iterator for QSet. More...

Public Methods

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

Detailed Description

template<typename T>
class QMutableSetIterator< T >

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

This iterator class is similar to QSetIterator with the addition of the remove() method. Modifying a value in a QSet using an iterator is not allowed. Remove the value and then add the new element.

See also
QSetIterator, QSet::iterator

Constructor & Destructor Documentation

template<typename T >
QMutableSetIterator< T >::QMutableSetIterator ( QSet< T > &  set)
inline

Constructs an iterator for traversing set. The iterator is set to the beginning of the set before the first item.

See also
operator=()
template<typename T >
QMutableSetIterator< T >::~QMutableSetIterator ( )
default

Destroys the iterator.

Method Documentation

template<typename T >
bool QMutableSetIterator< T >::findNext ( const T &  value)
inline

Searches for value starting from the current iterator position and moving forward. Returns true if the specified value is found, otherwise it returns false. If value is found the iterator is positioned just after the matching item, otherwise the iterator is positioned at the end of the container.

template<typename T >
bool QMutableSetIterator< T >::findPrevious ( const T &  value)
inline

Searches for value starting from the current iterator position and moving backward. Returns true if the specified value is found, otherwise it returns false. If value was found the iterator is positioned just before the matching item. Otherwise the iterator is positioned at the beginning of the container.

template<typename T >
bool QMutableSetIterator< T >::hasNext ( ) const
inline

Returns true if there is at least one item after the iterator, otherwise returns false.

See also
next()
template<typename T >
bool QMutableSetIterator< T >::hasPrevious ( ) const
inline

Returns true if there is at least one item before the iterator, otherwise returns false.

See also
next()
template<typename T >
const T & QMutableSetIterator< T >::next ( )
inline

Returns a reference to the next item and advances the iterator by one position. Calling this method on an iterator located at the end of the container causes undefined behavior.

See also
hasNext(), peekNext(), previous()
template<typename T >
QMutableSetIterator & QMutableSetIterator< T >::operator= ( QSet< T > &  set)
inline

Sets the iterator to the beginning of the set before the first item.

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

Returns a reference to the next item without moving the iterator. Calling this method on an iterator located at the end of the container causes undefined behavior.

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

Returns a reference to the previous item without moving the iterator. Calling this method on an iterator located at the beginning of the container causes undefined behavior.

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

Returns a reference to the previous item and moves the iterator back by one position. Calling this method on an iterator located at the beginning of the container leads to undefined results.

See also
hasPrevious(), peekPrevious(), next()
template<typename T >
void QMutableSetIterator< T >::remove ( )
inline

Removes the last item which was jumped over using one of the traversal methods next(), previous(), findNext(), findPrevious().

QMutableSetIterator<int> iter(set);
while (iter.hasNext()) {
int val = iter.next();
if (val < -32768 || val > 32767) {
iter.remove();
}
}
See also
value()
template<typename T >
void QMutableSetIterator< T >::toBack ( )
inline

Moves the iterator to the end of the container after the last item.

See also
toFront()
template<typename T >
void QMutableSetIterator< T >::toFront ( )
inline

Moves the iterator to the beginning of the container before the first item.

See also
toBack(), next()
template<typename T >
const T & QMutableSetIterator< T >::value ( ) const
inline

Returns a reference for the value of the last item that was jumped over using one of the traversal methods next(), previous(), findNext(), findPrevious().