Ogre::ConstVectorIterator< T > Class Template Reference

Concrete IteratorWrapper for const access to the underlying container. More...

`#include <OgreIteratorWrapper.h>`

Inheritance diagram for Ogre::ConstVectorIterator< T >:
[legend]

## 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 IteratorWrapper< T, T::const_iterator, typename T::value_type >::PointerType | PointerType
typedef IteratorWrapper< T, T::const_iterator, typename T::value_type >::ValueType | ValueType

## Public Member Functions

| ConstVectorIterator (typename T::const_iterator start, typename T::const_iterator last)
| Constructor. More...
| ConstVectorIterator (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...
ValueType | peekNext () const
| Returns the next(=current) element in the collection, without advancing to the next. More...
PointerType | peekNextPtr () const
| Returns a pointer to the next(=current) 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::ConstVectorIterator< T >

Concrete IteratorWrapper for const access to the underlying container.

Template Parameters

  T | = Container

Definition at line 217 of file OgreIteratorWrapper.h.

## Member Typedef Documentation

## const_iterator

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

## iterator

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

## PointerType

typedef IteratorWrapper<T, T::const_iterator , typename T::value_type>::PointerType Ogre::VectorIteratorWrapper< T, T::const_iterator >::PointerType

inherited

Definition at line 140 of file OgreIteratorWrapper.h.

## ValueType

typedef IteratorWrapper<T, T::const_iterator , typename T::value_type>::ValueType Ogre::VectorIteratorWrapper< T, T::const_iterator >::ValueType

inherited

Definition at line 139 of file OgreIteratorWrapper.h.

## Constructor & Destructor Documentation

## ConstVectorIterator() [1/2]

template<typename T >

Ogre::ConstVectorIterator< T >::ConstVectorIterator | ( | typename T::const_iterator | start,
|  | typename T::const_iterator | last
| ) |  |

Constructor.

Remarks
  Provide a start and end iterator to initialise.

Definition at line 223 of file OgreIteratorWrapper.h.

## ConstVectorIterator() [2/2]

template<typename T >

Ogre::ConstVectorIterator< T >::ConstVectorIterator | ( | const T & | c | ) |

explicit

Constructor.

Remarks
  Provide a container to initialise.

Definition at line 232 of file OgreIteratorWrapper.h.

## Member Function Documentation

## begin()

const T::const_iterator & Ogre::IteratorWrapper< T, T::const_iterator , T::value_type >::begin | ( |  | ) |

inherited

Bookmark to the begin of the underlying collection.

Definition at line 110 of file OgreIteratorWrapper.h.

## current()

T::const_iterator & Ogre::IteratorWrapper< T, T::const_iterator , T::value_type >::current | ( |  | ) |

inherited

Full access to the current iterator.

Definition at line 114 of file OgreIteratorWrapper.h.

## end()

const T::const_iterator & Ogre::IteratorWrapper< T, T::const_iterator , T::value_type >::end | ( | void |  | ) |

inherited

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

Definition at line 117 of file OgreIteratorWrapper.h.

## getNext()

ValueType Ogre::VectorIteratorWrapper< T, T::const_iterator >::getNext | ( |  | ) |

inherited

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

Definition at line 170 of file OgreIteratorWrapper.h.

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

## hasMoreElements()

bool Ogre::IteratorWrapper< T, T::const_iterator , T::value_type >::hasMoreElements | ( |  | ) | const

inherited

Returns true if there are more items in the collection.

Definition at line 97 of file OgreIteratorWrapper.h.

## moveNext()

void Ogre::IteratorWrapper< T, T::const_iterator , T::value_type >::moveNext | ( |  | ) |

inherited

Moves the iterator on one element.

Definition at line 104 of file OgreIteratorWrapper.h.

## peekNext()

ValueType Ogre::VectorIteratorWrapper< T, T::const_iterator >::peekNext | ( |  | ) | const

inherited

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

Definition at line 158 of file OgreIteratorWrapper.h.

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

## peekNextPtr()

PointerType Ogre::VectorIteratorWrapper< T, T::const_iterator >::peekNextPtr | ( |  | ) | const

inherited

Returns a pointer to the next(=current) element in the collection, without advancing to the next afterwards.

Definition at line 164 of file OgreIteratorWrapper.h.

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

## Member Data Documentation

## mBegin

T::const_iterator Ogre::IteratorWrapper< T, T::const_iterator , T::value_type >::mBegin

protected inherited

Definition at line 55 of file OgreIteratorWrapper.h.

## mCurrent

T::const_iterator Ogre::IteratorWrapper< T, T::const_iterator , T::value_type >::mCurrent

protected inherited

Definition at line 56 of file OgreIteratorWrapper.h.

## mEnd

T::const_iterator Ogre::IteratorWrapper< T, T::const_iterator , T::value_type >::mEnd

protected inherited

Definition at line 57 of file OgreIteratorWrapper.h.

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

- OgreIteratorWrapper.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.