ezEngine  Milestone 7
ezMapBase< KeyType, ValueType, Comparer >::Iterator Struct Reference

Forward Iterator to iterate over all elements in sorted order. More...

#include <Map.h>

Inheritance diagram for ezMapBase< KeyType, ValueType, Comparer >::Iterator:

Public Types

typedef std::forward_iterator_tag iterator_category
 
typedef Iterator value_type
 
typedef ptrdiff_t difference_type
 
typedef Iteratorpointer
 
typedef Iteratorreference
 
- Public Types inherited from ezMapBase< KeyType, ValueType, Comparer >::ConstIterator
typedef std::forward_iterator_tag iterator_category
 
typedef ConstIterator value_type
 
typedef ptrdiff_t difference_type
 
typedef ConstIteratorpointer
 
typedef ConstIteratorreference
 

Public Member Functions

 EZ_DECLARE_POD_TYPE ()
 
EZ_FORCE_INLINE Iterator ()
 Constructs an invalid iterator.
 
EZ_FORCE_INLINE ValueType & Value ()
 Returns the 'value' of the element that this iterator points to.
 
EZ_FORCE_INLINE ValueType & operator* ()
 Returns the 'value' of the element that this iterator points to.
 
- Public Member Functions inherited from ezMapBase< KeyType, ValueType, Comparer >::ConstIterator
 EZ_DECLARE_POD_TYPE ()
 
EZ_FORCE_INLINE ConstIterator ()
 Constructs an invalid iterator.
 
EZ_FORCE_INLINE bool IsValid () const
 Checks whether this iterator points to a valid element.
 
EZ_FORCE_INLINE bool operator== (const typename ezMapBase< KeyType, ValueType, Comparer >::ConstIterator &it2) const
 Checks whether the two iterators point to the same element.
 
EZ_FORCE_INLINE bool operator!= (const typename ezMapBase< KeyType, ValueType, Comparer >::ConstIterator &it2) const
 Checks whether the two iterators point to the same element.
 
EZ_FORCE_INLINE const KeyType & Key () const
 Returns the 'key' of the element that this iterator points to.
 
EZ_FORCE_INLINE const ValueType & Value () const
 Returns the 'value' of the element that this iterator points to.
 
void Next ()
 Advances the iterator to the next element in the map. The iterator will not be valid anymore, if the end is reached.
 
void Prev ()
 Advances the iterator to the previous element in the map. The iterator will not be valid anymore, if the end is reached.
 
EZ_FORCE_INLINE void operator++ ()
 Shorthand for 'Next'.
 
EZ_FORCE_INLINE void operator-- ()
 Shorthand for 'Prev'.
 

Private Member Functions

EZ_FORCE_INLINE Iterator (Node *pInit)
 

Friends

class ezMapBase< KeyType, ValueType, Comparer >
 

Additional Inherited Members

- Protected Member Functions inherited from ezMapBase< KeyType, ValueType, Comparer >::ConstIterator
EZ_FORCE_INLINE ConstIterator (Node *pInit)
 
- Protected Attributes inherited from ezMapBase< KeyType, ValueType, Comparer >::ConstIterator
Nodem_pElement
 

Detailed Description

template<typename KeyType, typename ValueType, typename Comparer>
struct ezMapBase< KeyType, ValueType, Comparer >::Iterator

Forward Iterator to iterate over all elements in sorted order.


The documentation for this struct was generated from the following file: