mbo::RefCntRep< _Ty, _THREAD_MODEL > Struct Template Reference

Reference counted pointer representation. More...

#include <MboRefCntPtr.h>

Collaboration diagram for mbo::RefCntRep< _Ty, _THREAD_MODEL >:

[legend]

List of all members.

Public Types
typedef RefCntRep< _Ty, _THREAD_MODEL >	Rep
typedef IncDecVal	refcount_type
Public Member Functions
	RefCntRep (_Ty *p=NULL)
RefCntRep &	AddRef ()
bool	Release ()
Static Public Member Functions
static Rep *	Alloc (_Ty *p)
static void	Dealloc (Rep *&pRep)
Public Attributes
refcount_type	refCnt
_Ty *	pData

---

Detailed Description

template<class _Ty, class _THREAD_MODEL = ThreadModel>
struct mbo::RefCntRep< _Ty, _THREAD_MODEL >

Reference counted pointer representation.

Warning:

this should only be used by RefCntPtr

Parameters:

	_Ty	type to use for target pointer
	_THREAD_MODEL	either SingleThreadedModel, MultiThreadedModel or the automatically selected ThreadModel.

Note:

This class is distributed under the following license GNU Lesser General Public License, version 2.1.

Definition at line 68 of file MboRefCntPtr.h.

---

Member Typedef Documentation

template<class _Ty, class _THREAD_MODEL = ThreadModel>

typedef RefCntRep<_Ty, _THREAD_MODEL> mbo::RefCntRep< _Ty, _THREAD_MODEL >::Rep

Shortname fot this instanciated this type in instanciated class types.

Definition at line 73 of file MboRefCntPtr.h.

template<class _Ty, class _THREAD_MODEL = ThreadModel>

typedef IncDecVal mbo::RefCntRep< _Ty, _THREAD_MODEL >::refcount_type

Type used for reference counting

Definition at line 77 of file MboRefCntPtr.h.

---

Constructor & Destructor Documentation

template<class _Ty, class _THREAD_MODEL = ThreadModel>

mbo::RefCntRep< _Ty, _THREAD_MODEL >::RefCntRep

(

_Ty *

p = NULL

)

[inline]

constructor

Parameters:

p

target pointer to use.

Definition at line 91 of file MboRefCntPtr.h.

        : refCnt(p ? 1 : 0)
        , pData(p) 
    {
    }

---

Member Function Documentation

template<class _Ty, class _THREAD_MODEL = ThreadModel>

RefCntRep& mbo::RefCntRep< _Ty, _THREAD_MODEL >::AddRef

(

)

[inline]

Increase number of references

Definition at line 99 of file MboRefCntPtr.h.

References mbo::RefCntRep< _Ty, _THREAD_MODEL >::refCnt.

Referenced by mbo::RefCntPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::operator=(), and mbo::RefCntPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::RefCntPtr().

    { 
        _THREAD_MODEL::Increment(&refCnt); 
        return *this;
    }

template<class _Ty, class _THREAD_MODEL = ThreadModel>

bool mbo::RefCntRep< _Ty, _THREAD_MODEL >::Release

(

)

[inline]

Decrease number of references and return true if reference count is zero. That is no more references are legal so that the instance itself (pData) can be deleted.

Returns:

whether reference count is zero and hence the pointer should be NULL.

Definition at line 112 of file MboRefCntPtr.h.

References mbo::RefCntRep< _Ty, _THREAD_MODEL >::refCnt.

Referenced by mbo::RefCntPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::__release().

    { 
        return !_THREAD_MODEL::Decrement(&refCnt); 
    }

template<class _Ty, class _THREAD_MODEL = ThreadModel>

static Rep* mbo::RefCntRep< _Ty, _THREAD_MODEL >::Alloc

(

_Ty *

p

)

[inline, static]

Allocate a new RefCntRep

Parameters:

p

target pointer to use

Returns:

newly created RefCntRep

Definition at line 122 of file MboRefCntPtr.h.

Referenced by mbo::RefCntPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::__assign(), and mbo::RefCntPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::operator=().

    { 
        return new Rep(p); 
    }

template<class _Ty, class _THREAD_MODEL = ThreadModel>

static void mbo::RefCntRep< _Ty, _THREAD_MODEL >::Dealloc

(

Rep *&

pRep

)

[inline, static]

Deallocate (free/delete) an already allocated RefCntRep

Parameters:

pRep

pointer to free

Definition at line 131 of file MboRefCntPtr.h.

Referenced by mbo::RefCntPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::__release().

    { 
        if (pRep)
        {
            if (pRep->pData)
            {
                delete pRep->pData;
            }
            delete pRep; 
            pRep = 0;
        }
    }

---

Member Data Documentation

template<class _Ty, class _THREAD_MODEL = ThreadModel>

refcount_type mbo::RefCntRep< _Ty, _THREAD_MODEL >::refCnt [mutable]

reference count

Definition at line 81 of file MboRefCntPtr.h.

Referenced by mbo::RefCntRep< _Ty, _THREAD_MODEL >::AddRef(), and mbo::RefCntRep< _Ty, _THREAD_MODEL >::Release().

template<class _Ty, class _THREAD_MODEL = ThreadModel>

_Ty* mbo::RefCntRep< _Ty, _THREAD_MODEL >::pData

target pointer

Definition at line 85 of file MboRefCntPtr.h.

Referenced by mbo::RefCntPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::__assign(), mbo::RefCntPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::__clone(), mbo::RefCntConstPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::operator unspecified_bool_type(), mbo::RefCntPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::operator unspecified_bool_type(), and mbo::RefCntPtr< _Ty, _THREAD_MODEL, _THREAD_MODEL_PTR >::operator=().

---

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

• MboRefCntPtr.h

---