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 IteratorType	const_iterator
	Typedef to fulfill container interface.
typedef IteratorType	iterator
	Typedef to fulfill container interface.
typedef IteratorWrapper< T, T::const_iterator, typenameT::value_type >::PointerType	PointerType
typedef IteratorWrapper< T, T::const_iterator, typenameT::value_type >::ValueType	ValueType

Public Member Functions
	ConstVectorIterator (const T &c)
	Constructor.
	ConstVectorIterator (typename T::const_iterator start, typename T::const_iterator last)
	Constructor.
const IteratorType &	begin ()
	Bookmark to the begin of the underlying collection.
IteratorType &	current ()
	Full access to the current iterator.
const IteratorType &	end ()
	Bookmark to the end (one behind the last element) of the underlying collection.
ValueType	getNext ()
	Returns the next(=current) value element in the collection, and advances to the next.
bool	hasMoreElements () const
	Returns true if there are more items in the collection.
void	moveNext ()
	Moves the iterator on one element.
ValueType	peekNext () const
	Returns the next(=current) element in the collection, without advancing to the next.
PointerType	peekNextPtr () const
	Returns a pointer to the next(=current) element in the collection, without advancing to the next afterwards.

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

template<typename T , typename IteratorType , typename ValType >

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

template<typename T , typename IteratorType , typename ValType >

typedef IteratorType Ogre::IteratorWrapper< T, IteratorType, ValType >::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 ,typenameT::value_type>::PointerType Ogre::VectorIteratorWrapper< T, T::const_iterator >::PointerType

inherited

ValueType

typedef IteratorWrapper<T,T::const_iterator ,typenameT::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()

template<typename T , typename IteratorType , typename ValType >

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

inlineinherited

Bookmark to the begin of the underlying collection.

current()

template<typename T , typename IteratorType , typename ValType >

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

inlineinherited

Full access to the current iterator.

end()

template<typename T , typename IteratorType , typename ValType >

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

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()

template<typename T , typename IteratorType , typename ValType >

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

inlineinherited

Returns true if there are more items in the collection.

moveNext()

template<typename T , typename IteratorType , typename ValType >

void Ogre::IteratorWrapper< T, IteratorType, ValType >::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:

• OgreIteratorWrapper.h