OGRE  2.2.4
Object-Oriented Graphics Rendering Engine
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 >:

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

Detailed Description

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

Concrete IteratorWrapper for const access to the underlying container.

Template Parameters
T= Container

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.

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

◆ PointerType

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

◆ ValueType

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

Constructor & Destructor Documentation

◆ ConstVectorIterator() [1/2]

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

Constructor.

Remarks
Provide a start and end iterator to initialise.

◆ ConstVectorIterator() [2/2]

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

Constructor.

Remarks
Provide a container to initialise.

Member Function Documentation

◆ begin()

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

Bookmark to the begin of the underlying collection.

◆ current()

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

Full access to the current iterator.

◆ end()

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

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

◆ getNext()

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

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

◆ hasMoreElements()

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

Returns true if there are more items in the collection.

◆ moveNext()

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

Moves the iterator on one element.

◆ peekNext()

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

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

◆ peekNextPtr()

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

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


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