Ogre::VectorIteratorWrapper< T, IteratorType > Class Template Reference

Prepiared IteratorWrapper for container like std::vector. More...

#include <OgreIteratorWrapper.h>

Inheritance diagram for Ogre::VectorIteratorWrapper< T, IteratorType >:

Collaboration diagram for Ogre::VectorIteratorWrapper< T, IteratorType >:

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

Public Member Functions
	VectorIteratorWrapper (IteratorType start, IteratorType last)
	c'tor More...
const IteratorType &	begin ()
	bookmark to the begin of the underlying collection More...
IteratorType &	current ()
	full access to the current iterator More...
const IteratorType &	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
IteratorType	mBegin
IteratorType	mCurrent
IteratorType	mEnd

Detailed Description

template<typename T, typename IteratorType>
class Ogre::VectorIteratorWrapper< T, IteratorType >

Prepiared IteratorWrapper for container like std::vector.

Parameters

T	= Container eg vector
IteratorType	T::iterator or T::const_iterator

have a look at VectorIterator and ConstVectorIterator for a more concrete usage

Definition at line 137 of file OgreIteratorWrapper.h.

Member Typedef Documentation

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

template<typename T, typename IteratorType>

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

Definition at line 142 of file OgreIteratorWrapper.h.

template<typename T, typename IteratorType>

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

Definition at line 141 of file OgreIteratorWrapper.h.

Constructor & Destructor Documentation

template<typename T, typename IteratorType>

Ogre::VectorIteratorWrapper< T, IteratorType >::VectorIteratorWrapper ( IteratorType  start, IteratorType  last  )

inline

c'tor

Constructor that provide a start and end iterator to initialise.

Parameters

start	start iterator
end	end iterator

Definition at line 153 of file OgreIteratorWrapper.h.

Member Function Documentation

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

inlineinherited

bookmark to the begin of the underlying collection

Definition at line 112 of file OgreIteratorWrapper.h.

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

inlineinherited

full access to the current iterator

Definition at line 116 of file OgreIteratorWrapper.h.

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

inlineinherited

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

Definition at line 119 of file OgreIteratorWrapper.h.

template<typename T, typename IteratorType>

ValueType Ogre::VectorIteratorWrapper< T, IteratorType >::getNext ( )

inline

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

Definition at line 172 of file OgreIteratorWrapper.h.

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

inlineinherited

Returns true if there are more items in the collection.

Definition at line 99 of file OgreIteratorWrapper.h.

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

inlineinherited

Moves the iterator on one element.

Definition at line 106 of file OgreIteratorWrapper.h.

template<typename T, typename IteratorType>

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

inline

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

Definition at line 160 of file OgreIteratorWrapper.h.

template<typename T, typename IteratorType>

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

inline

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

Definition at line 166 of file OgreIteratorWrapper.h.

Member Data Documentation

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

protectedinherited

Definition at line 54 of file OgreIteratorWrapper.h.

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

protectedinherited

Definition at line 55 of file OgreIteratorWrapper.h.

Referenced by Ogre::VectorIteratorWrapper< T, T::const_iterator >::getNext(), Ogre::VectorIteratorWrapper< T, T::const_iterator >::peekNext(), and Ogre::VectorIteratorWrapper< T, T::const_iterator >::peekNextPtr().

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

protectedinherited

Definition at line 56 of file OgreIteratorWrapper.h.

---

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

• OgreIteratorWrapper.h