gpucalc::SharedPtr< T > Class Template Reference

#include <utils.h>

List of all members.

Public Member Functions
void	bind (T *Pointer)
T *	get () const
T *	getPointer () const
bool	isNull () const
T &	operator* () const
T *	operator-> () const
template<class Y>
SharedPtr &	operator= (const SharedPtr< Y > &r)
SharedPtr &	operator= (const SharedPtr &r)
void	setNull ()
template<class Y>
	SharedPtr (const SharedPtr< Y > &r)
	SharedPtr (const SharedPtr &r)
template<class Y>
	SharedPtr (Y *Pointer)
	SharedPtr ()
bool	unique () const
unsigned int	useCount () const
unsigned int *	useCountPointer () const
virtual	~SharedPtr ()
Protected Member Functions
virtual void	destroy ()
void	release ()
virtual void	swap (SharedPtr< T > &other)
Protected Attributes
T *	mPointer
unsigned int *	mUseCount

---

Detailed Description

template<class T>
class gpucalc::SharedPtr< T >

Definition at line 56 of file utils.h.

---

Constructor & Destructor Documentation

template<class T>

gpucalc::SharedPtr< T >::SharedPtr

(

)

[inline]

Constructor, does not initialise the SharedPtr.

Remarks:

Dangerous! You have to call bind() before using the SharedPtr.

Definition at line 63 of file utils.h.

              : mPointer(0), mUseCount(0)
   {
   }

template<class T>

template<class Y>

gpucalc::SharedPtr< T >::SharedPtr

(

Y *

Pointer

)

[inline, explicit]

Constructor.

Parameters:

Pointer

The pointer to take ownership of

Definition at line 71 of file utils.h.

                                                     : mPointer(Pointer), mUseCount(new unsigned int(1))
   {
   }

template<class T>

gpucalc::SharedPtr< T >::SharedPtr

(

const SharedPtr< T > &

r

)

[inline]

Definition at line 76 of file utils.h.

                                 : mPointer(0), mUseCount(0)
   {
    mPointer = r.mPointer;
    mUseCount = r.mUseCount;
    if (mUseCount)
    {
     ++(*mUseCount);
    }
   }

template<class T>

template<class Y>

gpucalc::SharedPtr< T >::SharedPtr

(

const SharedPtr< Y > &

r

)

[inline]

Definition at line 101 of file utils.h.

                                                       : mPointer(0), mUseCount(0)
   {
    mPointer = r.getPointer();
    mUseCount = r.useCountPointer();
    // Handle zero pointer gracefully to manage STL containers
    if (mUseCount)
    {
     ++(*mUseCount);
    }
   }

template<class T>

virtual gpucalc::SharedPtr< T >::~SharedPtr

(

)

[inline, virtual]

Definition at line 127 of file utils.h.

   {
    release();
   }

---

Member Function Documentation

template<class T>

void gpucalc::SharedPtr< T >::bind

(

T *

Pointer

)

[inline]

Binds Pointer to the SharedPtr.

Remarks:

Assumes that the SharedPtr is uninitialised!

Definition at line 156 of file utils.h.

   {
    assert(!mPointer && !mUseCount);
    mUseCount = new unsigned int (1);
    mPointer = Pointer;
   }

template<class T>

virtual void gpucalc::SharedPtr< T >::destroy

(

)

[inline, protected, virtual]

Definition at line 231 of file utils.h.

   {
    // IF YOU GET A CRASH HERE, YOU FORGOT TO FREE UP POINTERS
    // BEFORE SHUTTING gpucalc DOWN
    // Use setNull() before shutdown or make sure your pointer goes
    // out of scope before gpucalc shuts down to avoid this.
    delete mPointer;
    delete mUseCount;
   }

template<class T>

T* gpucalc::SharedPtr< T >::get

(

)

const [inline]

Definition at line 147 of file utils.h.

   {
    return mPointer;
   }

template<class T>

T* gpucalc::SharedPtr< T >::getPointer

(

)

const [inline]

Definition at line 184 of file utils.h.

   {
    return mPointer;
   }

template<class T>

bool gpucalc::SharedPtr< T >::isNull

(

)

const [inline]

Definition at line 190 of file utils.h.

   {
    return mPointer == 0;
   }

template<class T>

T& gpucalc::SharedPtr< T >::operator*

(

)

const [inline]

Definition at line 133 of file utils.h.

   {
    assert(mPointer);
    return * mPointer;
   }

template<class T>

T* gpucalc::SharedPtr< T >::operator->

(

)

const [inline]

Definition at line 140 of file utils.h.

   {
    assert(mPointer);
    return mPointer;
   }

template<class T>

template<class Y>

SharedPtr& gpucalc::SharedPtr< T >::operator=

(

const SharedPtr< Y > &

r

)

[inline]

Definition at line 113 of file utils.h.

   {
    if (mPointer == r.mPointer)
    {
     return * this;
    }
    // Swap current data into a local copy
    // this ensures we deal with rhs and this being dependent
    SharedPtr<T> tmp(r);
    swap(tmp);
    return * this;
   }

template<class T>

SharedPtr& gpucalc::SharedPtr< T >::operator=

(

const SharedPtr< T > &

r

)

[inline]

Definition at line 87 of file utils.h.

   {
    if (mPointer == r.mPointer)
    {
     return * this;
    }
    // Swap current data into a local copy
    // this ensures we deal with rhs and this being dependent
    SharedPtr<T> tmp(r);
    swap(tmp);
    return * this;
   }

template<class T>

void gpucalc::SharedPtr< T >::release

(

)

[inline, protected]

Definition at line 214 of file utils.h.

   {
    bool destroyThis = false;
    if (mUseCount)
    {
     if (--(*mUseCount) == 0)
     {
      destroyThis = true;
     }
    }
    if (destroyThis)
    {
     destroy();
    }
   }

template<class T>

void gpucalc::SharedPtr< T >::setNull

(

)

[inline]

Definition at line 196 of file utils.h.

   {
    if (mPointer)
    {
     release();
     mPointer = 0;
     mUseCount = 0;
    }
   }

template<class T>

virtual void gpucalc::SharedPtr< T >::swap

(

SharedPtr< T > &

other

)

[inline, protected, virtual]

Definition at line 242 of file utils.h.

   {
    std::swap(mPointer, other.mPointer);
    std::swap(mUseCount, other.mUseCount);
   }

template<class T>

bool gpucalc::SharedPtr< T >::unique

(

)

const [inline]

Definition at line 164 of file utils.h.

   {
    assert(mUseCount);
    return * mUseCount == 1;
   }

template<class T>

unsigned int gpucalc::SharedPtr< T >::useCount

(

)

const [inline]

Definition at line 171 of file utils.h.

   {
    assert(mUseCount);
    return * mUseCount;
   }

template<class T>

unsigned int* gpucalc::SharedPtr< T >::useCountPointer

(

)

const [inline]

Definition at line 178 of file utils.h.

   {
    return mUseCount;
   }

---

Member Data Documentation

template<class T>

T* gpucalc::SharedPtr< T >::mPointer [protected]

Definition at line 209 of file utils.h.

template<class T>

unsigned int* gpucalc::SharedPtr< T >::mUseCount [protected]

Definition at line 211 of file utils.h.

---

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

• gpucalc/utils.h