Ogre::ConstVectorRange< T > Struct Template Reference

Predefined type. More...

#include <OgreIteratorRange.h>

Inheritance diagram for Ogre::ConstVectorRange< T >:

Public Types

typedef T const_iterator
 typedef to fulfill container interface
typedef T iterator
 typedef to fulfill container interface
typedef iterator_range< T > type
 defines the real used type

Public Member Functions

 ConstVectorRange (const T &c)
 Constructor.
 ConstVectorRange (const VectorRange< T > &rhs)
 Constructor.
 ConstVectorRange (typename T::const_iterator b, typename T::const_iterator e)
 Constructor.
 ConstVectorRange (typename T::iterator b, typename T::iterator e)
 Constructor.
T begin () const
 access to the begin of the range
bool empty () const
 informs if there are any elements in the range
T end () const
 access to the end of the range
bool equal (const iterator_range &other) const
 comparison for equality
bool operator!= (const ConstVectorRange &rhs) const
 comparison operator for inequality
bool operator!= (const iterator_range &rhs) const
 comparison operator for inequality
bool operator== (const ConstVectorRange &rhs) const
 comparison operator for equality
bool operator== (const iterator_range &rhs) const
 comparison operator for equality

Private Attributes

T mBegin
T mEnd

Detailed Description

template<typename T>
struct Ogre::ConstVectorRange< T >

Predefined type.

Template Parameters
Titerator type

compatility class for ConstVectorIterator

Definition at line 185 of file OgreIteratorRange.h.

Member Typedef Documentation

◆ const_iterator

template<typename T>
typedef T Ogre::iterator_range< T >::const_iterator
inherited

typedef to fulfill container interface

Note
there is no distinction between const_iterator and iterator.

Definition at line 117 of file OgreIteratorRange.h.

◆ iterator

template<typename T>
typedef T Ogre::iterator_range< T >::iterator
inherited

typedef to fulfill container interface

Note
there is no distinction between const_iterator and iterator.

Definition at line 109 of file OgreIteratorRange.h.

◆ type

template<typename T>
typedef iterator_range<T> Ogre::iterator_range< T >::type
inherited

defines the real used type

type will be defined as Ogre::iterator_range if not used with boost
otherwise the type will be boost::iterator_range

Definition at line 124 of file OgreIteratorRange.h.

Constructor & Destructor Documentation

◆ ConstVectorRange() [1/4]

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

Constructor.

Remarks
Provide a container to initialise.

Definition at line 192 of file OgreIteratorRange.h.

References Ogre::iterator_range< T >::iterator_range(), Ogre::iterator_range< T >::begin(), and Ogre::iterator_range< T >::end().

Referenced by operator!=(), and operator==().

◆ ConstVectorRange() [2/4]

template<typename T>
Ogre::ConstVectorRange< T >::ConstVectorRange ( typename T::iterator b,
typename T::iterator e )

Constructor.

Remarks
Provide a start and end iterator to initialise.

Definition at line 200 of file OgreIteratorRange.h.

References Ogre::iterator_range< T >::iterator_range().

◆ ConstVectorRange() [3/4]

template<typename T>
Ogre::ConstVectorRange< T >::ConstVectorRange ( typename T::const_iterator b,
typename T::const_iterator e )

Constructor.

Remarks
Provide a start and end const_iterator to initialise.

Definition at line 208 of file OgreIteratorRange.h.

References Ogre::iterator_range< T >::iterator_range().

◆ ConstVectorRange() [4/4]

template<typename T>
Ogre::ConstVectorRange< T >::ConstVectorRange ( const VectorRange< T > & rhs)

Constructor.

Remarks
Provide a VectorRange to initialise.

Definition at line 216 of file OgreIteratorRange.h.

References Ogre::iterator_range< T >::iterator_range(), Ogre::iterator_range< T >::begin(), and Ogre::iterator_range< T >::end().

Member Function Documentation

◆ begin()

◆ empty()

template<typename T>
bool Ogre::iterator_range< T >::empty ( ) const
inherited

informs if there are any elements in the range

Definition at line 90 of file OgreIteratorRange.h.

References mBegin, and mEnd.

◆ end()

◆ equal()

◆ operator!=() [1/2]

template<typename T>
bool Ogre::ConstVectorRange< T >::operator!= ( const ConstVectorRange< T > & rhs) const

comparison operator for inequality

Definition at line 223 of file OgreIteratorRange.h.

References ConstVectorRange(), and Ogre::iterator_range< T >::equal().

◆ operator!=() [2/2]

template<typename T>
bool Ogre::iterator_range< T >::operator!= ( const iterator_range< T > & rhs) const
inherited

comparison operator for inequality

Definition at line 101 of file OgreIteratorRange.h.

References iterator_range(), and operator==().

◆ operator==() [1/2]

template<typename T>
bool Ogre::ConstVectorRange< T >::operator== ( const ConstVectorRange< T > & rhs) const

comparison operator for equality

Definition at line 221 of file OgreIteratorRange.h.

References ConstVectorRange(), and Ogre::iterator_range< T >::equal().

◆ operator==() [2/2]

template<typename T>
bool Ogre::iterator_range< T >::operator== ( const iterator_range< T > & rhs) const
inherited

comparison operator for equality

Definition at line 97 of file OgreIteratorRange.h.

References iterator_range(), and equal().

Referenced by operator!=().

Member Data Documentation

◆ mBegin

template<typename T>
T Ogre::iterator_range< T >::mBegin
privateinherited

Definition at line 73 of file OgreIteratorRange.h.

Referenced by iterator_range(), begin(), empty(), and equal().

◆ mEnd

template<typename T>
T Ogre::iterator_range< T >::mEnd
privateinherited

Definition at line 73 of file OgreIteratorRange.h.

Referenced by iterator_range(), empty(), end(), and equal().


The documentation for this struct 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.