CopperSpice API  2.0.0
Public Typedefs | Public Methods | Friends | List of all members
QFlatMap< Key, Val, C >::const_iterator Class Reference
CsCore

STL style const iterator for QFlatMap. More...

Public Typedefs

using iterator_category = std::bidirectional_iterator_tag
 

Public Methods

 const_iterator () = default
 
 const_iterator (iterator iter)
 
const Key & key () const
 
bool operator!= (const_iterator other) const
 
const Val & operator* () const
 
const_iterator operator+ (size_type n) const
 
const_iterator & operator++ ()
 
const_iterator operator++ (int)
 
const_iterator & operator+= (size_type n)
 
const_iterator operator- (size_type n) const
 
const_iterator & operator-- ()
 
const_iterator operator-- (int)
 
const_iterator & operator-= (size_type n)
 
const Val * operator-> () const
 
bool operator== (const_iterator other) const
 
const std::pair< Key, Val > & pair () const
 
const Val & value () const
 

Friends

class QFlatMap< Key, Val, C >
 

Detailed Description

template<typename Key, typename Val, typename C>
class QFlatMap< Key, Val, C >::const_iterator

The QFlatMap::const_iterator class provides an STL style const iterator for QFlatMap. QFlatMap features both STL style iterators and Java style iterators.

QFlatMap::const_iterator allows you to iterate over a QFlatMap. If you want to modify the QFlatMap as you iterate over it use QFlatMap::iterator instead.

After construction you must initialize the iterator using a method like QFlatMap::constBegin(), QFlatMap::constEnd(), or QFlatMap::find() before you can start iterating.

The following example prints all of the (key, value) pairs stored in the flat map.

QFlatMap<QString, int> flatMap;
flatMap.insert("January", 1);
flatMap.insert("February", 2);
// ...
flatMap.insert("December", 12);
for (auto iter = flatMap.constBegin(); iter != flatMap.constEnd(); ++iter) {
cout << iter.key() << ": " << iter.value() << endl;
}
See also
QFlatMap::iterator

Member Typedef Documentation

template<typename Key , typename Val , typename C >
QFlatMap< Key, Val, C >::const_iterator::iterator_category

Equivalent to std::bidirectional_iterator_tag indicating this iterator is a bidirectional iterator.

Constructor & Destructor Documentation

template<typename Key , typename Val , typename C >
QFlatMap< Key, Val, C >::const_iterator::const_iterator ( )
default

Constructs an uninitialized iterator.

Methods like key(), value(), and operator++() must not be called on an uninitialized iterator. Use operator=() to assign a value to it before using it.

See also
QFlatMap::constBegin(), QFlatMap::constEnd()
template<typename Key , typename Val , typename C >
QFlatMap< Key, Val, C >::const_iterator::const_iterator ( iterator  iter)
inline

Constructs a copy of iter.

Method Documentation

template<typename Key , typename Val , typename C >
const Key & QFlatMap< Key, Val, C >::const_iterator::key ( ) const
inline

Returns the current item's key.

See also
value()
template<typename Key , typename Val , typename C >
bool QFlatMap< Key, Val, C >::const_iterator::operator!= ( const_iterator  other) const
inline

Returns true if other points to a different item than this iterator, otherwise it returns false.

See also
operator==()
template<typename Key , typename Val , typename C >
const Val & QFlatMap< Key, Val, C >::const_iterator::operator* ( ) const
inline

Returns the current item's value. Equivalent to calling value().

See also
key()
template<typename Key , typename Val , typename C >
const_iterator QFlatMap< Key, Val, C >::const_iterator::operator+ ( size_type  n) const
inline

Returns an iterator to the item at n positions forward from this iterator. If n is negative the iterator goes backward.

This operation can be slow for large values of n.

See also
operator-()
template<typename Key , typename Val , typename C >
const_iterator & QFlatMap< Key, Val, C >::const_iterator::operator++ ( )
inline

The prefix ++ operator advances the iterator to the next item in the flat map and returns an iterator to the new current item.

Calling this method on QFlatMap::cend() causes undefined behavior.

++iter;
See also
operator--()
template<typename Key , typename Val , typename C >
const_iterator QFlatMap< Key, Val, C >::const_iterator::operator++ ( int  )
inline

The postfix ++ operator advances the iterator to the next item in the flat map and returns an iterator to the previous current item.

Calling this method on QFlatMap::cend() causes undefined behavior.

iter++;
template<typename Key , typename Val , typename C >
const_iterator & QFlatMap< Key, Val, C >::const_iterator::operator+= ( size_type  n)
inline

Advances the iterator by n items. If n is negative the iterator goes backward.

This operation can be slow for large values of n.

See also
operator-=(), operator+()
template<typename Key , typename Val , typename C >
const_iterator QFlatMap< Key, Val, C >::const_iterator::operator- ( size_type  n) const
inline

Returns an iterator to the item at n positions backward from this iterator. If n is negative the iterator goes forward.

This operation can be slow for large values of n.

See also
operator+()
template<typename Key , typename Val , typename C >
const_iterator & QFlatMap< Key, Val, C >::const_iterator::operator-- ( )
inline

The prefix -- operator decrements the iterator to the previous item in the flat map and returns an iterator to the new current item.

Calling this method on QFlatMap::cbegin() causes undefined behavior.

--iter;
See also
operator++()
template<typename Key , typename Val , typename C >
const_iterator QFlatMap< Key, Val, C >::const_iterator::operator-- ( int  )
inline

The postfix -- operator decrements the iterator to the previous item in the flat map and returns an iterator to the previous current item.

Calling this method on QFlatMap::cbegin() causes undefined behavior.

iter--;
template<typename Key , typename Val , typename C >
const_iterator & QFlatMap< Key, Val, C >::const_iterator::operator-= ( size_type  n)
inline

Makes the iterator go back by n items. If n is negative the iterator goes forward. This operation can be slow for large values of n.

See also
operator+=(), operator-()
template<typename Key , typename Val , typename C >
const Val * QFlatMap< Key, Val, C >::const_iterator::operator-> ( ) const
inline

Returns a pointer to the current item's value.

See also
value()
template<typename Key , typename Val , typename C >
bool QFlatMap< Key, Val, C >::const_iterator::operator== ( const_iterator  other) const
inline

Returns true if other points to the same item as this iterator, otherwise it returns false.

See also
operator!=()
template<typename Key , typename Val , typename C >
const std::pair< Key, Val > & QFlatMap< Key, Val, C >::const_iterator::pair ( ) const
inline

Returns a pair consisting of the key and the value.

template<typename Key , typename Val , typename C >
const Val & QFlatMap< Key, Val, C >::const_iterator::value ( ) const
inline

Returns the current item's value.

See also
key(), operator*()