Buffer::const_iterator< T > Class Template Reference

Buffer's const iterator. More...

#include "Buffer.h"

Inheritance diagram for Buffer::const_iterator< T >:

Collaboration diagram for Buffer::const_iterator< T >:

Public Types
typedef _Base::iterator_category	iterator_category
	Typedef for iterator category. More...
typedef _Base::value_type	value_type
	Typedef for value type. More...
typedef _Base::difference_type	difference_type
	Typedef for difference type. More...
typedef _Base::pointer	pointer
	Typedef for pointer. More...
typedef _Base::reference	reference
	Typedef for reference. More...
typedef const T *	const_pointer
	Typedef for const pointer. More...
typedef const T &	const_reference
	Typedef for const reference. More...

Public Member Functions
	const_iterator (const Buffer *buffer=NULL, size_type index=0)
	Default constructor. More...
	const_iterator (const const_iterator &oth)
	Copy constructor. More...
const_iterator &	operator= (const const_iterator &oth)
	Copy operator. More...
template<typename T2 >
const_iterator< T2 >	As () const
	Converts const_iterator to another const_iterator with different type. More...
const_reference	operator* () const
	Dereference operator. More...
const_pointer	operator-> () const
	Dereference operator. More...
const_reference	operator[] (difference_type diff) const
	Subscript operator. More...
const_iterator	operator+ (difference_type diff) const
	Sum operator. More...
const_iterator &	operator+= (difference_type diff)
	Add operator. More...
const_iterator &	operator++ ()
	Preincrement operator. More...
const_iterator	operator++ (int)
	Postincrement operator. More...
const_iterator	operator- (difference_type diff) const
	Diff operator. More...
const_iterator &	operator-= (difference_type diff)
	Subtract operator. More...
const_iterator &	operator-- ()
	Predecrement operator. More...
const_iterator	operator-- (int)
	Postdecrement operator. More...
difference_type	operator- (const const_iterator &oth) const
	Diff operator. More...
bool	operator== (const const_iterator &oth) const
	Equal operator. More...
bool	operator!= (const const_iterator &oth) const
	Non-equal operator. More...
bool	operator< (const const_iterator &oth) const
	Less-than operator. More...
bool	operator> (const const_iterator &oth) const
	Greater-than operator. More...
bool	operator<= (const const_iterator &oth) const
	Less-equal operator. More...
bool	operator>= (const const_iterator &oth) const
	Greater-equal operator. More...

Protected Attributes
size_type	mIndex
	Index in buffer, in bytes. More...
const Buffer *	mBuffer
	The parent Buffer. More...

Private Types
typedef std::iterator < std::random_access_iterator_tag, T >	_Base
	Typedef for our base due to readibility. More...

Detailed Description

template<typename T>
class Buffer::const_iterator< T >

Buffer's const iterator.

Author

Bloody.Rabbit

Definition at line 52 of file Buffer.h.

Member Typedef Documentation

template<typename T>

typedef std::iterator< std::random_access_iterator_tag, T > Buffer::const_iterator< T >::_Base

private

Typedef for our base due to readibility.

Definition at line 56 of file Buffer.h.

template<typename T>

typedef const T* Buffer::const_iterator< T >::const_pointer

Typedef for const pointer.

Definition at line 71 of file Buffer.h.

template<typename T>

typedef const T& Buffer::const_iterator< T >::const_reference

Typedef for const reference.

Definition at line 73 of file Buffer.h.

template<typename T>

typedef _Base::difference_type Buffer::const_iterator< T >::difference_type

Typedef for difference type.

Definition at line 64 of file Buffer.h.

template<typename T>

typedef _Base::iterator_category Buffer::const_iterator< T >::iterator_category

Typedef for iterator category.

Definition at line 60 of file Buffer.h.

template<typename T>

typedef _Base::pointer Buffer::const_iterator< T >::pointer

Typedef for pointer.

Definition at line 66 of file Buffer.h.

template<typename T>

typedef _Base::reference Buffer::const_iterator< T >::reference

Typedef for reference.

Definition at line 68 of file Buffer.h.

template<typename T>

typedef _Base::value_type Buffer::const_iterator< T >::value_type

Typedef for value type.

Definition at line 62 of file Buffer.h.

Constructor & Destructor Documentation

template<typename T>

Buffer::const_iterator< T >::const_iterator ( const Buffer *  buffer = NULL, size_type  index = 0  )

inline

Default constructor.

Parameters

[in]	buffer	The parent Buffer.
[in]	index	The index.

Definition at line 81 of file Buffer.h.

        : mIndex( index ),
          mBuffer( buffer )
        {
        }

template<typename T>

Buffer::const_iterator< T >::const_iterator ( const const_iterator< T > &  oth )

inline

Copy constructor.

Definition at line 87 of file Buffer.h.

        : mIndex( oth.mIndex ),
          mBuffer( oth.mBuffer )
        {
        }

Member Function Documentation

template<typename T>

template<typename T2 >

const_iterator< T2 > Buffer::const_iterator< T >::As ( ) const

inline

Converts const_iterator to another const_iterator with different type.

Returns

The new const_iterator.

Definition at line 108 of file Buffer.h.

Referenced by UnmarshalStream::LoadPackedRow(), UnmarshalStream::Peek(), and StreamPacketizer::Process().

{ return const_iterator< T2 >( mBuffer, mIndex ); }

Here is the caller graph for this function:

template<typename T>

bool Buffer::const_iterator< T >::operator!= ( const const_iterator< T > &  oth ) const

inline

Non-equal operator.

Definition at line 196 of file Buffer.h.

{ return !( *this == oth ); }

template<typename T>

const_reference Buffer::const_iterator< T >::operator* ( ) const

inline

Dereference operator.

Definition at line 111 of file Buffer.h.

        {
            // make sure we have valid buffer
            assert( mBuffer );
            // make sure we're not going off the bounds
            assert( 1 <= mBuffer->end< value_type >() - *this );

            // obtain the value and return
            return *(const_pointer)&( mBuffer->mBuffer )[ mIndex ];
        }

template<typename T>

const_iterator Buffer::const_iterator< T >::operator+ ( difference_type  diff ) const

inline

Sum operator.

Definition at line 127 of file Buffer.h.

        {
            const_iterator res( *this );
            return ( res += diff );
        }

template<typename T>

const_iterator& Buffer::const_iterator< T >::operator++ ( )

inline

Preincrement operator.

Definition at line 151 of file Buffer.h.

{ return ( *this += 1 );  }

template<typename T>

const_iterator Buffer::const_iterator< T >::operator++ ( int  )

inline

Postincrement operator.

Definition at line 153 of file Buffer.h.

        {
            const_iterator res( *this );
            ++*this;
            return res;
        }

template<typename T>

const_iterator& Buffer::const_iterator< T >::operator+= ( difference_type  diff )

inline

Add operator.

Definition at line 133 of file Buffer.h.

        {
            // turn the diff into byte diff
            const difference_type res = ( diff * sizeof( value_type ) );

            // make sure we have valid buffer
            assert( mBuffer );
            // make sure we won't go negative
            assert( 0 <= mIndex + res );
            // make sure we won't go past end
            assert( mIndex + res <= mBuffer->size() );

            // set new index
            mIndex += res;

            return *this;
        }

template<typename T>

const_iterator Buffer::const_iterator< T >::operator- ( difference_type  diff ) const

inline

Diff operator.

Definition at line 161 of file Buffer.h.

        {
            const_iterator res( *this );
            return ( res -= diff );
        }

template<typename T>

difference_type Buffer::const_iterator< T >::operator- ( const const_iterator< T > &  oth ) const

inline

Diff operator.

Definition at line 179 of file Buffer.h.

        {
            // make sure we have same parent buffer
            assert( oth.mBuffer == mBuffer );
            // return difference in element offset
            return ( ( mIndex - oth.mIndex ) / sizeof( value_type ) );
        }

template<typename T>

const_iterator& Buffer::const_iterator< T >::operator-- ( )

inline

Predecrement operator.

Definition at line 169 of file Buffer.h.

{ return ( *this -= 1 ); }

template<typename T>

const_iterator Buffer::const_iterator< T >::operator-- ( int  )

inline

Postdecrement operator.

Definition at line 171 of file Buffer.h.

        {
            const_iterator res( *this );
            --*this;
            return res;
        }

template<typename T>

const_iterator& Buffer::const_iterator< T >::operator-= ( difference_type  diff )

inline

Subtract operator.

Definition at line 167 of file Buffer.h.

{ return ( *this += ( -diff ) ); }

template<typename T>

const_pointer Buffer::const_iterator< T >::operator-> ( ) const

inline

Dereference operator.

Definition at line 122 of file Buffer.h.

{ return &**this; }

template<typename T>

bool Buffer::const_iterator< T >::operator< ( const const_iterator< T > &  oth ) const

inline

Less-than operator.

Definition at line 199 of file Buffer.h.

        {
            // make sure we have same parent buffer
            assert( oth.mBuffer == mBuffer );
            // return the result
            return ( mIndex < oth.mIndex );
        }

template<typename T>

bool Buffer::const_iterator< T >::operator<= ( const const_iterator< T > &  oth ) const

inline

Less-equal operator.

Definition at line 215 of file Buffer.h.

{ return !( *this > oth ); }

template<typename T>

const_iterator& Buffer::const_iterator< T >::operator= ( const const_iterator< T > &  oth )

inline

Copy operator.

Definition at line 94 of file Buffer.h.

        {
            mIndex = oth.mIndex;
            mBuffer = oth.mBuffer;
            return *this;
        }

template<typename T>

bool Buffer::const_iterator< T >::operator== ( const const_iterator< T > &  oth ) const

inline

Equal operator.

Definition at line 188 of file Buffer.h.

        {
            // make sure we have same parent buffer
            assert( oth.mBuffer == mBuffer );
            // return the result
            return ( mIndex == oth.mIndex );
        }

template<typename T>

bool Buffer::const_iterator< T >::operator> ( const const_iterator< T > &  oth ) const

inline

Greater-than operator.

Definition at line 207 of file Buffer.h.

        {
            // make sure we have same parent buffer
            assert( oth.mBuffer == mBuffer );
            // return the result
            return ( mIndex > oth.mIndex );
        }

template<typename T>

bool Buffer::const_iterator< T >::operator>= ( const const_iterator< T > &  oth ) const

inline

Greater-equal operator.

Definition at line 217 of file Buffer.h.

{ return !( *this < oth ); }

template<typename T>

const_reference Buffer::const_iterator< T >::operator[] ( difference_type  diff ) const

inline

Subscript operator.

Definition at line 124 of file Buffer.h.

{ return *( *this + diff ); }

Member Data Documentation

template<typename T>

const Buffer* Buffer::const_iterator< T >::mBuffer

protected

The parent Buffer.

Definition at line 223 of file Buffer.h.

Referenced by Buffer::const_iterator< uint8 >::As(), Buffer::iterator< T >::As(), Buffer::const_iterator< uint8 >::operator*(), Buffer::const_iterator< uint8 >::operator+=(), Buffer::const_iterator< uint8 >::operator-(), Buffer::const_iterator< uint8 >::operator<(), Buffer::const_iterator< uint8 >::operator=(), Buffer::const_iterator< uint8 >::operator==(), and Buffer::const_iterator< uint8 >::operator>().

template<typename T>

size_type Buffer::const_iterator< T >::mIndex

protected

Index in buffer, in bytes.

Definition at line 221 of file Buffer.h.

Referenced by Buffer::const_iterator< uint8 >::As(), Buffer::iterator< T >::As(), Buffer::const_iterator< uint8 >::operator*(), Buffer::const_iterator< uint8 >::operator+=(), Buffer::const_iterator< uint8 >::operator-(), Buffer::const_iterator< uint8 >::operator<(), Buffer::const_iterator< uint8 >::operator=(), Buffer::const_iterator< uint8 >::operator==(), and Buffer::const_iterator< uint8 >::operator>().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/utils/Buffer.h