OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 >:
+ Collaboration 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...
 

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

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.

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.

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.

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

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.

Definition at line 223 of file OgreIteratorWrapper.h.

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

Constructor.

Remarks
Provide a container to initialise.

Definition at line 232 of file OgreIteratorWrapper.h.

Member Function Documentation

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

Bookmark to the begin of the underlying collection.

Definition at line 110 of file OgreIteratorWrapper.h.

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

Full access to the current iterator.

Definition at line 114 of file OgreIteratorWrapper.h.

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.

Definition at line 117 of file OgreIteratorWrapper.h.

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

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, T::value_type >::mCurrent.

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

Returns true if there are more items in the collection.

Definition at line 97 of file OgreIteratorWrapper.h.

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

Moves the iterator on one element.

Definition at line 104 of file OgreIteratorWrapper.h.

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

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, T::value_type >::mCurrent.

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.

Definition at line 164 of file OgreIteratorWrapper.h.

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

Member Data Documentation

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

Definition at line 55 of file OgreIteratorWrapper.h.

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

Definition at line 56 of file OgreIteratorWrapper.h.

T::const_iterator Ogre::IteratorWrapper< T, T::const_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: