Ogre::VectorRange< T > Struct Template Reference

Predefined type. More...

`#include <OgreIteratorRange.h>`

Inheritance diagram for Ogre::VectorRange< T >:
[legend]

## Public Types

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

## Public Member Functions

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

## Detailed Description

### template<typename T>
struct Ogre::VectorRange< T >

Predefined type.

Template Parameters

  T | iterator type

compatility class for VectorIterator

Definition at line 142 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

## VectorRange() [1/2]

template<typename T>

Ogre::VectorRange< T >::VectorRange | ( | T & | c | ) |

Constructor.

Remarks
  Provide a container to initialise.

Definition at line 149 of file OgreIteratorRange.h.

## VectorRange() [2/2]

template<typename T>

Ogre::VectorRange< T >::VectorRange | ( | typename T::iterator | b,
|  | typename T::iterator | e
| ) |  |

Constructor.

Remarks
  Provide a start and end iterator to initialise.

Definition at line 157 of file OgreIteratorRange.h.

## Member Function Documentation

## begin()

template<typename T>

T Ogre::iterator_range< T >::begin | ( |  | ) | const

inherited

access to the begin of the range

Definition at line 84 of file OgreIteratorRange.h.

References Ogre::iterator_range< T >::mBegin.

Referenced by Ogre::VectorRange< T >::operator!=(), Ogre::ConstVectorRange< T >::operator!=(), Ogre::MapRange< T >::operator!=(), and Ogre::ConstMapRange< T >::operator!=().

## 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 Ogre::iterator_range< T >::mEnd.

## end()

template<typename T>

T Ogre::iterator_range< T >::end | ( |  | ) | const

inherited

access to the end of the range

Definition at line 87 of file OgreIteratorRange.h.

References Ogre::iterator_range< T >::mEnd.

Referenced by Ogre::VectorRange< T >::operator!=(), Ogre::ConstVectorRange< T >::operator!=(), Ogre::MapRange< T >::operator!=(), and Ogre::ConstMapRange< T >::operator!=().

## equal()

template<typename T>

bool Ogre::iterator_range< T >::equal | ( | const iterator_range< T > & | other | ) | const

inherited

comparison for equality

Definition at line 93 of file OgreIteratorRange.h.

References Ogre::iterator_range< T >::mBegin, and Ogre::iterator_range< T >::mEnd.

Referenced by Ogre::VectorRange< T >::operator!=(), Ogre::ConstVectorRange< T >::operator!=(), Ogre::MapRange< T >::operator!=(), Ogre::ConstMapRange< T >::operator!=(), Ogre::iterator_range< T >::operator==(), Ogre::VectorRange< T >::operator==(), Ogre::ConstVectorRange< T >::operator==(), Ogre::MapRange< T >::operator==(), and Ogre::ConstMapRange< T >::operator==().

## operator!=() [1/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 Ogre::iterator_range< T >::operator==().

## operator!=() [2/2]

template<typename T>

bool Ogre::VectorRange< T >::operator!= | ( | const VectorRange< T > & | rhs | ) | const

comparison operator for inequality

Definition at line 164 of file OgreIteratorRange.h.

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

## operator==() [1/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 Ogre::iterator_range< T >::equal().

Referenced by Ogre::iterator_range< T >::operator!=().

## operator==() [2/2]

template<typename T>

bool Ogre::VectorRange< T >::operator== | ( | const VectorRange< T > & | rhs | ) | const

comparison operator for equality

Definition at line 162 of file OgreIteratorRange.h.

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

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

- OgreIteratorRange.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.