Concurrency::_Source_link_iterator< _LinkRegistry > Class Template Reference

Const Iterator for referenced link manager. More...

#include <agents.h>

Public Types
typedef _LinkRegistry::type	_Block
typedef _Source_link_iterator< _LinkRegistry >	_Myt
typedef source_link_manager< _LinkRegistry >	_MyContainer
typedef _Block *	_EType
typedef _EType const &	const_reference
typedef _EType const *	const_pointer

Public Member Functions
	_Source_link_iterator (_MyContainer *_PNetwork_link, size_t _Index)
	Construct iterator More...
virtual	~_Source_link_iterator ()
	Destruct iterator More...
	_Source_link_iterator (_Myt const &_Right)
	Copy construct an iterator More...
_Myt const &	operator= (_Myt const &_Right)
	Copy assign an iterator More...
const_reference	operator* ()
	Returns the object pointed to by the iterator More...
const_pointer	operator-> () const
	Returns a pointer to the class object More...
const_reference	operator[] (size_t _Pos) const
	Index operation. Retrieve an element at the specified index. More...
_Myt &	operator++ ()
	Pre-increment the iterator to point to the next element More...
_Myt	operator++ (int)
	Post-increment the iterator to point to the next element More...

Private Member Functions
const_reference	_Get (size_t _Pos) const

Private Attributes
::Concurrency::details::_Dynamic_array< _EType >	_M_array
_MyContainer *	_M_pNetwork_link
size_t	_M_index
_EType	_M_sentinel

Detailed Description

template<class _LinkRegistry>
class Concurrency::_Source_link_iterator< _LinkRegistry >

Const Iterator for referenced link manager.

Template Parameters

_LinkRegistry

The underlying network link registry

Member Typedef Documentation

template<class _LinkRegistry >

typedef _LinkRegistry::type Concurrency::_Source_link_iterator< _LinkRegistry >::_Block

template<class _LinkRegistry >

typedef _Block* Concurrency::_Source_link_iterator< _LinkRegistry >::_EType

template<class _LinkRegistry >

typedef source_link_manager<_LinkRegistry> Concurrency::_Source_link_iterator< _LinkRegistry >::_MyContainer

template<class _LinkRegistry >

typedef _Source_link_iterator<_LinkRegistry> Concurrency::_Source_link_iterator< _LinkRegistry >::_Myt

template<class _LinkRegistry >

typedef _EType const* Concurrency::_Source_link_iterator< _LinkRegistry >::const_pointer

template<class _LinkRegistry >

typedef _EType const& Concurrency::_Source_link_iterator< _LinkRegistry >::const_reference

Constructor & Destructor Documentation

template<class _LinkRegistry >

Concurrency::_Source_link_iterator< _LinkRegistry >::_Source_link_iterator ( _MyContainer *  _PNetwork_link, size_t  _Index  )

inline

Construct iterator

                                                                        : _M_pNetwork_link(_PNetwork_link), _M_index(_Index), _M_sentinel(NULL)
    {
        // Take a snapshot of the link registry. This will reference the registry.
        _M_pNetwork_link->_To_array(_M_array);
    }

template<class _LinkRegistry >

virtual Concurrency::_Source_link_iterator< _LinkRegistry >::~_Source_link_iterator ( )

inlinevirtual

Destruct iterator

    {
        if (_M_pNetwork_link != NULL)
        {
            _M_pNetwork_link->release();
        }
    }

template<class _LinkRegistry >

Concurrency::_Source_link_iterator< _LinkRegistry >::_Source_link_iterator ( _Myt const &  _Right )

inline

Copy construct an iterator

    {
        _M_pNetwork_link = _Right._M_pNetwork_link;
        _M_index = _Right._M_index;
        _M_array = _Right._M_array;

        _M_pNetwork_link->reference();
    }

Member Function Documentation

template<class _LinkRegistry >

const_reference Concurrency::_Source_link_iterator< _LinkRegistry >::_Get ( size_t  _Pos ) const

inlineprivate

    {
        size_t _Index = _M_index + _Pos;
        if (_Index >= _M_array._Size())
        {
            return _M_sentinel;
        }

        return _M_array[_Index];
    }

template<class _LinkRegistry >

const_reference Concurrency::_Source_link_iterator< _LinkRegistry >::operator* ( )

inline

Returns the object pointed to by the iterator

Returns

Reference to the object pointed to by the iterator

    {
        return _Get(0);
    }

template<class _LinkRegistry >

_Myt& Concurrency::_Source_link_iterator< _LinkRegistry >::operator++ ( )

inline

Pre-increment the iterator to point to the next element

Returns

Reference to the object pointer to by the iterator after incrementing it

    {
        ++_M_index;
        return (*this);
    }

template<class _LinkRegistry >

_Myt Concurrency::_Source_link_iterator< _LinkRegistry >::operator++ ( int  )

inline

Post-increment the iterator to point to the next element

Returns

Reference to the object pointer to by the iterator before incrementing it

    {
        _Myt _Tmp = *this;
        ++*this;
        return (_Tmp);
    }

template<class _LinkRegistry >

const_pointer Concurrency::_Source_link_iterator< _LinkRegistry >::operator-> ( ) const

inline

Returns a pointer to the class object

Returns

Returns a pointer to the class object

    {
        return (&**this);
    }

template<class _LinkRegistry >

_Myt const& Concurrency::_Source_link_iterator< _LinkRegistry >::operator= ( _Myt const &  _Right )

inline

Copy assign an iterator

    {
        _MyContainer * _OldContainer = _M_pNetwork_link;
        _CONCRT_ASSERT(_OldContainer != NULL);

        _M_pNetwork_link = _Right._M_pNetwork_link;
        _M_index = _Right._M_index;
        _M_array = _Right._M_array;

        if (_OldContainer != _M_pNetwork_link)
        {
            _OldContainer->release();
            _M_pNetwork_link->reference();
        }

        return *this;
    }

template<class _LinkRegistry >

const_reference Concurrency::_Source_link_iterator< _LinkRegistry >::operator[] ( size_t  _Pos ) const

inline

Index operation. Retrieve an element at the specified index.

    {
        return _Get(_Pos);
    }

Member Data Documentation

template<class _LinkRegistry >

::Concurrency::details::_Dynamic_array<_EType> Concurrency::_Source_link_iterator< _LinkRegistry >::_M_array

private

template<class _LinkRegistry >

size_t Concurrency::_Source_link_iterator< _LinkRegistry >::_M_index

private

template<class _LinkRegistry >

_MyContainer* Concurrency::_Source_link_iterator< _LinkRegistry >::_M_pNetwork_link

private

template<class _LinkRegistry >

_EType Concurrency::_Source_link_iterator< _LinkRegistry >::_M_sentinel

private

---

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

• VS2013/inc/agents.h