Ogre::ConstMapIterator< T > Class Template Reference

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

#include <OgreIteratorWrapper.h>

Inheritance diagram for Ogre::ConstMapIterator< T >:
Inheritance graph
[legend]

List of all members.

Public Types

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

Public Member Functions

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

Protected Attributes

T::const_iterator mBegin
T::const_iterator mCurrent
T::const_iterator mEnd

Detailed Description

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

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

Parameters:
T key-value container

Definition at line 354 of file OgreIteratorWrapper.h.


Member Typedef Documentation

typedef T::const_iterator Ogre::IteratorWrapper< T, T::const_iterator , 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 T::const_iterator Ogre::IteratorWrapper< T, T::const_iterator , 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.

typedef T::key_type Ogre::MapIteratorWrapper< T, T::const_iterator >::KeyType [inherited]

type you expect to get by funktions like peekNextKey

Definition at line 267 of file OgreIteratorWrapper.h.

typedef T::value_type Ogre::MapIteratorWrapper< T, T::const_iterator >::PairType [inherited]

unused, just to make it clear that map/setvalue_type is not a ValueType

Definition at line 265 of file OgreIteratorWrapper.h.

typedef IteratorWrapper<T, T::const_iterator , typename T::mapped_type>::PointerType Ogre::MapIteratorWrapper< T, T::const_iterator >::PointerType [inherited]

redefined PointerType for a map/set

Reimplemented from Ogre::IteratorWrapper< T, T::const_iterator, T::mapped_type >.

Definition at line 262 of file OgreIteratorWrapper.h.

typedef IteratorWrapper<T, T::const_iterator , typename T::mapped_type>::ValueType Ogre::MapIteratorWrapper< T, T::const_iterator >::ValueType [inherited]

redefined ValueType for a map/set

Reimplemented from Ogre::IteratorWrapper< T, T::const_iterator, T::mapped_type >.

Definition at line 260 of file OgreIteratorWrapper.h.


Constructor & Destructor Documentation

template<typename T >
Ogre::ConstMapIterator< T >::ConstMapIterator ( typename T::const_iterator  start,
typename T::const_iterator  last 
)

Constructor.

Remarks:
Provide a start and end iterator to initialise.

Definition at line 361 of file OgreIteratorWrapper.h.

template<typename T >
Ogre::ConstMapIterator< T >::ConstMapIterator ( const T &  c  )  [explicit]

Constructor.

Remarks:
Provide a container to initialise.

Definition at line 370 of file OgreIteratorWrapper.h.


Member Function Documentation

const T::const_iterator & Ogre::IteratorWrapper< T, T::const_iterator , T::mapped_type >::begin (  )  [inherited]

bookmark to the begin of the underlying collection

Definition at line 112 of file OgreIteratorWrapper.h.

T::const_iterator & Ogre::IteratorWrapper< T, T::const_iterator , T::mapped_type >::current (  )  [inherited]

full access to the current iterator

Definition at line 116 of file OgreIteratorWrapper.h.

const T::const_iterator & Ogre::IteratorWrapper< T, T::const_iterator , T::mapped_type >::end ( void   )  [inherited]

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

Definition at line 119 of file OgreIteratorWrapper.h.

ValueType Ogre::MapIteratorWrapper< T, T::const_iterator >::getNext ( void   )  [inherited]

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

Definition at line 301 of file OgreIteratorWrapper.h.

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

bool Ogre::IteratorWrapper< T, T::const_iterator , T::mapped_type >::hasMoreElements (  )  const [inherited]

Returns true if there are more items in the collection.

Definition at line 99 of file OgreIteratorWrapper.h.

void Ogre::IteratorWrapper< T, T::const_iterator , T::mapped_type >::moveNext (  )  [inherited]

Moves the iterator on one element.

Definition at line 106 of file OgreIteratorWrapper.h.

KeyType Ogre::MapIteratorWrapper< T, T::const_iterator >::peekNextKey ( void   )  const [inherited]

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

Definition at line 279 of file OgreIteratorWrapper.h.

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

ValueType Ogre::MapIteratorWrapper< T, T::const_iterator >::peekNextValue (  )  const [inherited]

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

Definition at line 286 of file OgreIteratorWrapper.h.

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

const PointerType Ogre::MapIteratorWrapper< T, T::const_iterator >::peekNextValuePtr (  )  const [inherited]

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.

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


Member Data Documentation

T::const_iterator Ogre::IteratorWrapper< T, T::const_iterator , T::mapped_type >::mBegin [protected, inherited]

Definition at line 54 of file OgreIteratorWrapper.h.

T::const_iterator Ogre::IteratorWrapper< T, T::const_iterator , T::mapped_type >::mCurrent [protected, inherited]

Definition at line 55 of file OgreIteratorWrapper.h.

T::const_iterator Ogre::IteratorWrapper< T, T::const_iterator , T::mapped_type >::mEnd [protected, inherited]

Definition at line 56 of file OgreIteratorWrapper.h.


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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Fri May 25 23:37:59 2012