vpr::RefCountMemory Class Reference

Reference countable memory. More...

#include <vpr/Util/RefCountMemory.h>

List of all members.

Public Types
enum	States { BAD = -69 }
Public Member Functions
	RefCountMemory ()
	Default constructor.
	RefCountMemory (const RefCountMemory &r)
	On creation, refcount == 0, so if you intend to own the memory created, you should ref it.
RefCountMemory &	operator= (const RefCountMemory &r)
const int &	ref ()
	Increases the reference count.
bool	unrefDelete ()
	Decreases the reference count by 1, then call checkDelete.
const int &	unref ()
	Decreases the reference count.
const int &	getRef () const
	Gets the reference count.
const int &	unrefGetRef ()
	Decreases the reference count by 1, return the new refcount.
virtual bool	checkDelete ()
	If refcount <= 0, then delete the memory.
Protected Member Functions
virtual	~RefCountMemory ()
	Destructor.

---

Detailed Description

Reference countable memory.

(No, not radio controlled, sorry.)

To use reference counting on your objects, inherit from this class.

NOTES:

• you MUST call unrefDelete or checkDelete to delete, do not call operator::delete() yourself!!!!!
• on creation, refcount == 0, so if you intend to own the memory created, you should call ref() on the object

EXAMPLE USAGE: Object obj; obj.ref(); // count == 1; obj.ref(); // count == 2; int count = obj.getRef(); obj.unrefDelete(); // count == 1, memory is not deleted obj.unrefDelete(); // count == 0, memory is deleted

class Object : public vpr::RefCountMemory

Deprecated:

Use boost::shared_ptr<T> instead.

Definition at line 73 of file RefCountMemory.h.

---

Member Enumeration Documentation

enum vpr::RefCountMemory::States

Enumerator:

BAD

Definition at line 76 of file RefCountMemory.h.

      {
         BAD = -69,
      };

---

Constructor & Destructor Documentation

vpr::RefCountMemory::RefCountMemory

(

)

[inline]

Default constructor.

On creation, refcount == 0, so if you intend to own the memory created, you should ref it

Definition at line 152 of file RefCountMemory.h.

                                         : ___mNumTimesReferenced( 0 )
   {
   }

vpr::RefCountMemory::RefCountMemory

(

const RefCountMemory &

r

)

[inline]

On creation, refcount == 0, so if you intend to own the memory created, you should ref it.

Definition at line 91 of file RefCountMemory.h.

                                                : ___mNumTimesReferenced( 0 )
       {
          //dont copy ref number.
       }

virtual vpr::RefCountMemory::~RefCountMemory

(

)

[inline, protected, virtual]

Destructor.

You MUST call checkDelete to delete, do not call delete!!!!!

Definition at line 101 of file RefCountMemory.h.

References BAD.

       {
          assert( ___mNumTimesReferenced != BAD && ___mNumTimesReferenced >= 0 && "this data has been dereferenced more times than referenced, someone is probably holding on to the data after they called deref(), or someone called deref too many times. also, make sure you use checkDelete, or unrefDelete." );
          ___mNumTimesReferenced = BAD;
       }

---

Member Function Documentation

RefCountMemory& vpr::RefCountMemory::operator=

(

const RefCountMemory &

r

)

[inline]

Definition at line 108 of file RefCountMemory.h.

       {
          //dont copy ref number.
          return *this;
       }

const int & vpr::RefCountMemory::ref

(

)

[inline]

Increases the reference count.

Definition at line 164 of file RefCountMemory.h.

References BAD, and getRef().

   {
      assert( ___mNumTimesReferenced != BAD && "this data has been deleted, someone is probably holding on to the data after they called deref()" );
      ++___mNumTimesReferenced;
      return this->getRef();
   }

bool vpr::RefCountMemory::unrefDelete

(

)

[inline]

Decreases the reference count by 1, then call checkDelete.

This is equivalent to calling RefCountMemory::unref followed by RefCountMemory::checkDelete

Returns:

true if deleted; false if not.

Definition at line 207 of file RefCountMemory.h.

References checkDelete(), and unref().

   {
      this->unref();
      return this->checkDelete();
   }

const int & vpr::RefCountMemory::unref

(

)

[inline]

Decreases the reference count.

Definition at line 172 of file RefCountMemory.h.

References BAD, and getRef().

Referenced by unrefDelete(), and unrefGetRef().

   {
      assert( ___mNumTimesReferenced != BAD && ___mNumTimesReferenced >= 0 && "this data has been dereferenced more times than referenced, someone is probably holding on to the data after they called deref(), or someone called deref too many times. also, make sure you use checkDelete, or unrefDelete." );
      --___mNumTimesReferenced;
      return this->getRef();
   }

const int & vpr::RefCountMemory::getRef

(

)

const [inline]

Gets the reference count.

Definition at line 157 of file RefCountMemory.h.

References BAD.

Referenced by ref(), unref(), and unrefGetRef().

   {
      assert( ___mNumTimesReferenced != BAD && "this data has been deleted, someone is probably holding on to the data after they called deref()" );
      return ___mNumTimesReferenced;
   }

const int & vpr::RefCountMemory::unrefGetRef

(

)

[inline]

Decreases the reference count by 1, return the new refcount.

Definition at line 214 of file RefCountMemory.h.

References getRef(), and unref().

   {
      this->unref();
      return this->getRef();
   }

bool vpr::RefCountMemory::checkDelete

(

)

[inline, virtual]

If refcount <= 0, then delete the memory.

If the object has any refcountable children, then they will have RefCountMemory::unrefDelete() called on them.

Returns:

true if deleted, false if not

Definition at line 186 of file RefCountMemory.h.

References BAD.

Referenced by unrefDelete().

   {
      assert( ___mNumTimesReferenced != BAD && ___mNumTimesReferenced >= 0 && "this data has been dereferenced more times than referenced, someone is probably holding on to the data after they called deref(), or someone called deref too many times. also, make sure you use checkDelete, or unrefDelete." );
      if (___mNumTimesReferenced <= 0)
      {
         delete this;
         return true;
      }
      else
      {
         return false;
      }   
   }

---

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

• RefCountMemory.h

---