OGRE  1.12.1
Object-Oriented Graphics Rendering Engine
Ogre::MapIterator< T > Class Template Reference

Concrete IteratorWrapper for nonconst access to the underlying key-value container. More...

#include <OgreIteratorWrapper.h>

+ Inheritance diagram for Ogre::MapIterator< T >:

Public Types

typedef T::iterator const_iterator
 Typedef to fulfill container interface. More...
 
typedef T::iterator iterator
 Typedef to fulfill container interface. More...
 
typedef T::key_type KeyType
 Type you expect to get by funktions like peekNextKey. More...
 
typedef T::value_type PairType
 Unused, just to make it clear that map/set::value_type is not a ValueType. More...
 
typedef IteratorWrapper< T, T::iterator, typename T::mapped_type >::PointerType PointerType
 Redefined PointerType for a map/set. More...
 
typedef IteratorWrapper< T, T::iterator, typename T::mapped_type >::ValueType ValueType
 Redefined ValueType for a map/set. More...
 

Public Member Functions

 MapIterator (typename T::iterator start, typename T::iterator last)
 Constructor. More...
 
 MapIterator (T &c)
 Constructor. More...
 
const T::iterator & begin ()
 Bookmark to the begin of the underlying collection. More...
 
T::iterator & current ()
 Full access to the current iterator. More...
 
const T::iterator & end ()
 Bookmark to the end (one behind the last element) of the underlying collection. More...
 
ValueType getNext ()
 Returns the next(=current) value element in the collection, and advances to the next. More...
 
bool hasMoreElements () const
 Returns true if there are more items in the collection. More...
 
void moveNext ()
 Moves the iterator on one element. More...
 
KeyType peekNextKey (void) const
 Returns the next(=current) key element in the collection, without advancing to the next. More...
 
ValueType peekNextValue () const
 Returns the next(=current) value element in the collection, without advancing to the next. More...
 
const PointerType peekNextValuePtr () const
 Returns a pointer to the next/current value element in the collection, without advancing to the next afterwards. More...
 

Detailed Description

template<typename T>
class Ogre::MapIterator< T >

Concrete IteratorWrapper for nonconst access to the underlying key-value container.

Remarks
Template key-value container

Member Typedef Documentation

◆ ValueType

typedef IteratorWrapper<T, T::iterator , typename T::mapped_type>::ValueType Ogre::MapIteratorWrapper< T, T::iterator >::ValueType
inherited

Redefined ValueType for a map/set.

◆ PointerType

typedef IteratorWrapper<T, T::iterator , typename T::mapped_type>::PointerType Ogre::MapIteratorWrapper< T, T::iterator >::PointerType
inherited

Redefined PointerType for a map/set.

◆ PairType

typedef T::value_type Ogre::MapIteratorWrapper< T, T::iterator >::PairType
inherited

Unused, just to make it clear that map/set::value_type is not a ValueType.

◆ KeyType

typedef T::key_type Ogre::MapIteratorWrapper< T, T::iterator >::KeyType
inherited

Type you expect to get by funktions like peekNextKey.

◆ iterator

typedef T::iterator Ogre::IteratorWrapper< T, T::iterator , T::mapped_type >::iterator
inherited

Typedef to fulfill container interface.

Useful if you want to use BOOST_FOREACH

Note
there is no distinction between const_iterator and iterator.
keep this in mind if you want to derivate from this class.

◆ const_iterator

typedef T::iterator Ogre::IteratorWrapper< T, T::iterator , T::mapped_type >::const_iterator
inherited

Typedef to fulfill container interface.

Useful if you want to use BOOST_FOREACH

Note
there is no distinction between const_iterator and iterator.
keep this in mind if you want to derivate from this class.

Constructor & Destructor Documentation

◆ MapIterator() [1/2]

template<typename T>
Ogre::MapIterator< T >::MapIterator ( typename T::iterator  start,
typename T::iterator  last 
)
inline

Constructor.

Remarks
Provide a start and end iterator to initialise.

◆ MapIterator() [2/2]

template<typename T>
Ogre::MapIterator< T >::MapIterator ( T &  c)
inlineexplicit

Constructor.

Remarks
Provide a container to initialise.

Member Function Documentation

◆ peekNextKey()

KeyType Ogre::MapIteratorWrapper< T, T::iterator >::peekNextKey ( void  ) const
inlineinherited

Returns the next(=current) key element in the collection, without advancing to the next.

◆ peekNextValue()

ValueType Ogre::MapIteratorWrapper< T, T::iterator >::peekNextValue ( ) const
inlineinherited

Returns the next(=current) value element in the collection, without advancing to the next.

◆ peekNextValuePtr()

const PointerType Ogre::MapIteratorWrapper< T, T::iterator >::peekNextValuePtr ( ) const
inlineinherited

Returns a pointer to the next/current value element in the collection, without advancing to the next afterwards.

◆ getNext()

ValueType Ogre::MapIteratorWrapper< T, T::iterator >::getNext ( )
inlineinherited

Returns the next(=current) value element in the collection, and advances to the next.

◆ hasMoreElements()

bool Ogre::IteratorWrapper< T, T::iterator , T::mapped_type >::hasMoreElements ( ) const
inlineinherited

Returns true if there are more items in the collection.

◆ moveNext()

void Ogre::IteratorWrapper< T, T::iterator , T::mapped_type >::moveNext ( )
inlineinherited

Moves the iterator on one element.

◆ begin()

const T::iterator & Ogre::IteratorWrapper< T, T::iterator , T::mapped_type >::begin ( )
inlineinherited

Bookmark to the begin of the underlying collection.

◆ current()

T::iterator & Ogre::IteratorWrapper< T, T::iterator , T::mapped_type >::current ( )
inlineinherited

Full access to the current iterator.

◆ end()

const T::iterator & Ogre::IteratorWrapper< T, T::iterator , T::mapped_type >::end ( void  )
inlineinherited

Bookmark to the end (one behind the last element) of the underlying collection.


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