Public Types | Public Member Functions | Protected Attributes | List of all members
Ogre::VectorIterator< T > Class Template Reference

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

#include <OgreIteratorWrapper.h>

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

Public Types

typedef T::iterator const_iterator
 Typedef to fulfill container interface. More...
 
typedef T::iterator iterator
 Typedef to fulfill container interface. More...
 
typedef IteratorWrapper< T, T::iterator, typename T::value_type >::PointerType PointerType
 
typedef IteratorWrapper< T, T::iterator, typename T::value_type >::ValueType ValueType
 

Public Member Functions

 VectorIterator (typename T::iterator start, typename T::iterator last)
 Constructor. More...
 
 VectorIterator (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...
 
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::iterator mBegin
 
T::iterator mCurrent
 
T::iterator mEnd
 

Detailed Description

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

Concrete IteratorWrapper for nonconst access to the underlying container.

Template Parameters
TContainer

Definition at line 186 of file OgreIteratorWrapper.h.

Member Typedef Documentation

◆ const_iterator

typedef T::iterator Ogre::IteratorWrapper< T, T::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::iterator Ogre::IteratorWrapper< T, T::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::iterator , typename T::value_type>::PointerType Ogre::VectorIteratorWrapper< T, T::iterator >::PointerType
inherited

Definition at line 140 of file OgreIteratorWrapper.h.

◆ ValueType

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

Definition at line 139 of file OgreIteratorWrapper.h.

Constructor & Destructor Documentation

◆ VectorIterator() [1/2]

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

Constructor.

Remarks
Provide a start and end iterator to initialise.

Definition at line 192 of file OgreIteratorWrapper.h.

◆ VectorIterator() [2/2]

template<typename T >
Ogre::VectorIterator< T >::VectorIterator ( T &  c)
explicit

Constructor.

Remarks
Provide a container to initialise.

Definition at line 201 of file OgreIteratorWrapper.h.

Member Function Documentation

◆ begin()

const T::iterator & Ogre::IteratorWrapper< T, T::iterator , T::value_type >::begin ( )
inherited

Bookmark to the begin of the underlying collection.

Definition at line 110 of file OgreIteratorWrapper.h.

◆ current()

T::iterator & Ogre::IteratorWrapper< T, T::iterator , T::value_type >::current ( )
inherited

Full access to the current iterator.

Definition at line 114 of file OgreIteratorWrapper.h.

◆ end()

const T::iterator & Ogre::IteratorWrapper< T, T::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::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.

◆ hasMoreElements()

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

◆ peekNextPtr()

PointerType Ogre::VectorIteratorWrapper< T, T::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.

Member Data Documentation

◆ mBegin

T::iterator Ogre::IteratorWrapper< T, T::iterator , T::value_type >::mBegin
protectedinherited

Definition at line 55 of file OgreIteratorWrapper.h.

◆ mCurrent

T::iterator Ogre::IteratorWrapper< T, T::iterator , T::value_type >::mCurrent
protectedinherited

Definition at line 56 of file OgreIteratorWrapper.h.

◆ mEnd

T::iterator Ogre::IteratorWrapper< T, T::iterator , T::value_type >::mEnd
protectedinherited

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