OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 >:
+ Collaboration diagram for Ogre::ConstMapIterator< T >:

Public Types

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

Public Member Functions

 ConstMapIterator (typename T::const_iterator start, typename T::const_iterator last)
 Constructor. More...
 
 ConstMapIterator (const T &c)
 Constructor. More...
 
const T::const_iterator & begin ()
 Bookmark to the begin of the underlying collection. More...
 
T::const_iterator & current ()
 Full access to the current iterator. More...
 
const T::const_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...
 

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.

Template Parameters
Tkey-value container

Definition at line 352 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.

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.

Definition at line 83 of file OgreIteratorWrapper.h.

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

Definition at line 74 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 265 of file OgreIteratorWrapper.h.

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

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

Definition at line 263 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.

Definition at line 260 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.

Definition at line 258 of file OgreIteratorWrapper.h.

Constructor & Destructor Documentation

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

Constructor.

Remarks
Provide a start and end iterator to initialise.

Definition at line 359 of file OgreIteratorWrapper.h.

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

Constructor.

Remarks
Provide a container to initialise.

Definition at line 368 of file OgreIteratorWrapper.h.

Member Function Documentation

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

Bookmark to the begin of the underlying collection.

Definition at line 110 of file OgreIteratorWrapper.h.

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

Full access to the current iterator.

Definition at line 114 of file OgreIteratorWrapper.h.

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

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

Definition at line 117 of file OgreIteratorWrapper.h.

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

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

Definition at line 299 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
inlineinherited

Returns true if there are more items in the collection.

Definition at line 97 of file OgreIteratorWrapper.h.

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

Moves the iterator on one element.

Definition at line 104 of file OgreIteratorWrapper.h.

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

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

Definition at line 277 of file OgreIteratorWrapper.h.

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

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

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

Definition at line 284 of file OgreIteratorWrapper.h.

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

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

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

Definition at line 292 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
protectedinherited

Definition at line 55 of file OgreIteratorWrapper.h.

T::const_iterator Ogre::IteratorWrapper< T, T::const_iterator , T::mapped_type >::mCurrent
protectedinherited

Definition at line 56 of file OgreIteratorWrapper.h.

T::const_iterator Ogre::IteratorWrapper< T, T::const_iterator , T::mapped_type >::mEnd
protectedinherited

Definition at line 57 of file OgreIteratorWrapper.h.


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