Ogre::MapIteratorWrapper< T, IteratorType > Class Template Reference

Prepiared IteratorWrapper for key-value container. More...

#include <OgreIteratorWrapper.h>

Inheritance diagram for Ogre::MapIteratorWrapper< T, IteratorType >:

Collaboration diagram for Ogre::MapIteratorWrapper< T, IteratorType >:

Public Types
typedef IteratorType	const_iterator
	typedef to fulfill container interface More...
typedef IteratorType	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, IteratorType, typename T::mapped_type >::PointerType	PointerType
	redefined PointerType for a map/set More...
typedef IteratorWrapper< T, IteratorType, typename T::mapped_type >::ValueType	ValueType
	redefined ValueType for a map/set More...

Public Member Functions
	MapIteratorWrapper (IteratorType start, IteratorType last)
	Constructor. More...
const IteratorType &	begin ()
	bookmark to the begin of the underlying collection More...
IteratorType &	current ()
	full access to the current iterator More...
const IteratorType &	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...

Protected Attributes
IteratorType	mBegin
IteratorType	mCurrent
IteratorType	mEnd

Detailed Description

template<typename T, typename IteratorType>
class Ogre::MapIteratorWrapper< T, IteratorType >

Prepiared IteratorWrapper for key-value container.

Parameters

T	Container (map - or also set )
IteratorType	T::iterator or T::const_iterator

have a look at MapIterator and ConstMapIterator for a concrete usage

Definition at line 255 of file OgreIteratorWrapper.h.

Member Typedef Documentation

typedef IteratorType Ogre::IteratorWrapper< T, IteratorType, T::mapped_type >::const_iterator

inherited

typedef to fulfill container interface

Userfull 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.

Definition at line 82 of file OgreIteratorWrapper.h.

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

inherited

typedef to fulfill container interface

Userfull 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.

Definition at line 73 of file OgreIteratorWrapper.h.

template<typename T, typename IteratorType>

typedef T::key_type Ogre::MapIteratorWrapper< T, IteratorType >::KeyType

type you expect to get by funktions like peekNextKey

Definition at line 267 of file OgreIteratorWrapper.h.

template<typename T, typename IteratorType>

typedef T::value_type Ogre::MapIteratorWrapper< T, IteratorType >::PairType

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

Definition at line 265 of file OgreIteratorWrapper.h.

template<typename T, typename IteratorType>

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

redefined PointerType for a map/set

Definition at line 262 of file OgreIteratorWrapper.h.

template<typename T, typename IteratorType>

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

redefined ValueType for a map/set

Definition at line 260 of file OgreIteratorWrapper.h.

Constructor & Destructor Documentation

template<typename T, typename IteratorType>

Ogre::MapIteratorWrapper< T, IteratorType >::MapIteratorWrapper ( IteratorType  start, IteratorType  last  )

inline

Constructor.

Remarks

Provide a start and end iterator to initialise.

Definition at line 273 of file OgreIteratorWrapper.h.

Member Function Documentation

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

inlineinherited

bookmark to the begin of the underlying collection

Definition at line 112 of file OgreIteratorWrapper.h.

References Ogre::IteratorWrapper< T, IteratorType, ValType >::mBegin.

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

inlineinherited

full access to the current iterator

Definition at line 116 of file OgreIteratorWrapper.h.

References Ogre::IteratorWrapper< T, IteratorType, ValType >::mCurrent.

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

inlineinherited

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

Definition at line 119 of file OgreIteratorWrapper.h.

References Ogre::IteratorWrapper< T, IteratorType, ValType >::mEnd.

template<typename T, typename IteratorType>

ValueType Ogre::MapIteratorWrapper< T, IteratorType >::getNext ( )

inline

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

Definition at line 301 of file OgreIteratorWrapper.h.

Referenced by Ogre::RenderQueueGroup::merge().

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

inlineinherited

Returns true if there are more items in the collection.

Definition at line 99 of file OgreIteratorWrapper.h.

References Ogre::IteratorWrapper< T, IteratorType, ValType >::mCurrent, and Ogre::IteratorWrapper< T, IteratorType, ValType >::mEnd.

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

inlineinherited

Moves the iterator on one element.

Definition at line 106 of file OgreIteratorWrapper.h.

References Ogre::IteratorWrapper< T, IteratorType, ValType >::mCurrent.

template<typename T, typename IteratorType>

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

inline

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

Definition at line 279 of file OgreIteratorWrapper.h.

Referenced by Ogre::RenderQueueGroup::merge().

template<typename T, typename IteratorType>

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

inline

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

Definition at line 286 of file OgreIteratorWrapper.h.

template<typename T, typename IteratorType>

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

inline

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

Definition at line 294 of file OgreIteratorWrapper.h.

Member Data Documentation

IteratorType Ogre::IteratorWrapper< T, IteratorType, T::mapped_type >::mBegin

protectedinherited

Definition at line 54 of file OgreIteratorWrapper.h.

IteratorType Ogre::IteratorWrapper< T, IteratorType, T::mapped_type >::mCurrent

protectedinherited

Definition at line 55 of file OgreIteratorWrapper.h.

Referenced by Ogre::MapIteratorWrapper< T, T::const_iterator >::getNext(), Ogre::MapIteratorWrapper< T, T::const_iterator >::peekNextKey(), Ogre::MapIteratorWrapper< T, T::const_iterator >::peekNextValue(), and Ogre::MapIteratorWrapper< T, T::const_iterator >::peekNextValuePtr().

IteratorType Ogre::IteratorWrapper< T, IteratorType, T::mapped_type >::mEnd

protectedinherited

Definition at line 56 of file OgreIteratorWrapper.h.

---

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

• OgreIteratorWrapper.h