RefPtr< RefObjectType, SafeRefObjectType, LifeTimePolicy > Class Template Reference

This template class act similar as CComPtr. More...

#include <IRefObject.h>

Inheritance diagram for RefPtr< RefObjectType, SafeRefObjectType, LifeTimePolicy >:

Public Types
typedef RefObjectType	ObjectType
typedef RefPtr< RefObjectType, SafeRefObjectType, LifeTimePolicy >	SelfType

Public Member Functions
	RefPtr ()
	RefPtr (RefObjectType *pPtr)
	RefPtr (const SelfType &other)
template<class OtherInterface , class OtherSafeRefObjectType , class OtherLifeTimePolicy >
	RefPtr (const RefPtr< OtherInterface, OtherSafeRefObjectType, OtherLifeTimePolicy > &other)
template<class OtherInterface >
	RefPtr (OtherInterface *pPtr)
	~RefPtr ()
void	Swap (SelfType &other)
void	Release ()
	operator RefObjectType * () const
RefObjectType &	operator* () const
RefObjectType *	GetPointer () const
SafeRefObjectType *	operator-> () const
RefObjectType *	operator= (RefObjectType *pPtr)
RefObjectType *	operator= (const SelfType &other)
template<class OtherInterface >
RefObjectType *	operator= (OtherInterface *pPtr)
template<class OtherInterface , class OtherSafeRefObjectType , class OtherLifeTimePolicy >
RefObjectType *	operator= (const RefPtr< OtherInterface, OtherSafeRefObjectType, OtherLifeTimePolicy > &other)
bool	operator! () const
bool	operator< (RefObjectType *pPtr) const
bool	operator< (const SelfType &pPtr) const
bool	operator== (RefObjectType *pPtr) const
bool	operator== (const SelfType &pPtr) const
bool	operator!= (RefObjectType *pPtr) const
bool	operator!= (const SelfType &pPtr) const

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Detailed Description

template<class RefObjectType, class SafeRefObjectType = SafeReferenceObjectProxy<RefObjectType>, class LifeTimePolicy = DefaultLifeTimePolicy<RefObjectType>>
class MaxSDK::Graphics::RefPtr< RefObjectType, SafeRefObjectType, LifeTimePolicy >

This template class act similar as CComPtr.

Using RefPtr<RefObjectType> will be much safer than RefObjectType* since this template class handles the AddRef and Release in its constructor and destructor.

Usage Example: class DerivedRefObject : public ARefObject { public: void foo(); };

Use DerivedRefObject without RefPtr: { DerivedRefObject* pObject = new DerivedRefObject; pObject->AddRef(); // Add reference pObject->foo(); pObject->Release(); // release the object pObject = NULL; }

Use DerivedRefObject with RefPtr: { RefPtr<DerivedRefObject> pObject = new DerivedRefObject; pObject->foo(); don't need to worry about deleting this object }

More RefPtr examples: RefPtr<DerivedRefObject> pObject2 = new DerivedRefObject; RefPtr<DerivedRefObject> pObject3 = pObject2; pObject2 = NULL; // pObject3 is still valid. pObject3->foo(); pObject3 = NULL; // Release the last reference to the object and the object is destroyed automatically.

Member Typedef Documentation

ObjectType

typedef RefObjectType ObjectType

SelfType

typedef RefPtr<RefObjectType, SafeRefObjectType, LifeTimePolicy> SelfType

Constructor & Destructor Documentation

RefPtr() [1/5]

RefPtr ( )

inline

    {
        mpObject = NULL;
    }

RefPtr() [2/5]

RefPtr ( RefObjectType *  pPtr )

inline

    {
        mpObject = pPtr;
        if (mpObject != NULL)
        {
            LifeTimePolicy::AddRef(mpObject);
        }
    }

RefPtr() [3/5]

RefPtr ( const SelfType &  other )

inline

    {
        mpObject = other.mpObject;
        if (mpObject != NULL)
        {
            LifeTimePolicy::AddRef(mpObject);
        }
    }

RefPtr() [4/5]

RefPtr ( const RefPtr< OtherInterface, OtherSafeRefObjectType, OtherLifeTimePolicy > &  other )

inlineexplicit

    {
        if (other == NULL)
        {
            mpObject = NULL;
            return;
        }
        mpObject = dynamic_cast<RefObjectType*>(other.GetPointer());
        if (NULL != mpObject)
        {
            LifeTimePolicy::AddRef(mpObject);
        }
    }

RefPtr() [5/5]

RefPtr ( OtherInterface *  pPtr )

inlineexplicit

    {
        if (pPtr == NULL)
        {
            mpObject = NULL;
        }
        else
        {
            mpObject = dynamic_cast<RefObjectType*>(pPtr);
        }
        if (NULL != mpObject)
        {
            LifeTimePolicy::AddRef(mpObject);
        }
    }

~RefPtr()

~RefPtr ( )

inline

    {
        Release();
    }

Member Function Documentation

Swap()

void Swap ( SelfType &  other )

inline

    {
        RefObjectType* pTemp = mpObject;
        mpObject = other.mpObject;
        other.mpObject = pTemp;
    }

Release()

void Release ( )

inline

    {
        RefObjectType* pTemp = mpObject;
        if (mpObject)
        {
            mpObject = NULL;
            LifeTimePolicy::Release(pTemp);
        }
    }

operator RefObjectType *()

operator RefObjectType * ( ) const

inline

    {
        return mpObject;
    }

operator*()

RefObjectType& operator* ( ) const

inline

    {
        return *mpObject;
    }

GetPointer()

RefObjectType* GetPointer ( ) const

inline

    {
        return mpObject;
    }

operator->()

SafeRefObjectType* operator-> ( ) const

inline

    {
        return (SafeRefObjectType*)mpObject;
    }

operator=() [1/4]

RefObjectType* operator= ( RefObjectType *  pPtr )

inline

    {
        if (pPtr != NULL)
        {
            LifeTimePolicy::AddRef(pPtr);
        }
        if (mpObject)
        {
            LifeTimePolicy::Release(mpObject);
        }
        mpObject = pPtr;
        return pPtr;
    }

operator=() [2/4]

RefObjectType* operator= ( const SelfType &  other )

inline

    {
        RefObjectType* pPtr = other.mpObject;
        if (pPtr != NULL)
        {
            LifeTimePolicy::AddRef(pPtr);
        }
        if (mpObject)
        {
            LifeTimePolicy::Release(mpObject);
        }
        mpObject = pPtr;
        return pPtr;
    }

operator=() [3/4]

RefObjectType* operator= ( OtherInterface *  pPtr )

inline

    {
        RefObjectType* pBackup = mpObject;
        if (pPtr != NULL)
        {
            mpObject = dynamic_cast<RefObjectType*>(pPtr);
        }
        else
        {
            mpObject = NULL;
        }
        if (NULL != mpObject)
        {
            LifeTimePolicy::AddRef(mpObject);
        }
 
        if (pBackup != NULL)
        {
            LifeTimePolicy::Release(pBackup);
        }
        return mpObject;
    }

operator=() [4/4]

RefObjectType* operator= ( const RefPtr< OtherInterface, OtherSafeRefObjectType, OtherLifeTimePolicy > &  other )

inline

    {
        RefObjectType* pBackup = mpObject;
        if (other != NULL)
        {
            mpObject = dynamic_cast<RefObjectType*>(other.GetPointer());
        }
        else
        {
            mpObject = NULL;
        }
        if (NULL != mpObject)
        {
            LifeTimePolicy::AddRef(mpObject);
        }
 
        if (pBackup != NULL)
        {
            LifeTimePolicy::Release(pBackup);
        }
        return mpObject;
    }

operator!()

bool operator! ( ) const

inline

    {
        return mpObject == NULL;
    }

operator<() [1/2]

bool operator< ( RefObjectType *  pPtr ) const

inline

    {
        return mpObject < pPtr;
    }

operator<() [2/2]

bool operator< ( const SelfType &  pPtr ) const

inline

    {
        return mpObject < pPtr.mpObject;
    }

operator==() [1/2]

bool operator== ( RefObjectType *  pPtr ) const

inline

    {
        return mpObject == pPtr;
    }

operator==() [2/2]

bool operator== ( const SelfType &  pPtr ) const

inline

    {
        return mpObject == pPtr.mpObject;
    }

operator!=() [1/2]

bool operator!= ( RefObjectType *  pPtr ) const

inline

    {
        return mpObject != pPtr;
    }

operator!=() [2/2]

bool operator!= ( const SelfType &  pPtr ) const

inline

    {
        return mpObject != pPtr.mpObject;
    }