template<typename ref_data, typename CreateDataFunctor = _Default_ModifyData<ref_data>, typename DestroyDataFunctor = _Default_ModifyData<ref_data> > class TRefCounter

A template class that can be used to implement reference counting.

Public Methods

TRefCounter(CreateDataFunctor _create, DestroyDataFunctor _destroy)

Initialize a reference counter that refers to a new data object.

virtual ~TRefCounter()

When a reference counter is destroyed, the data's reference count is decremented and if required, destroyed

this_type& operator = (const this_type& V)

Makes this reference counter into a refer to the data refered to by "V", first removing reference to whatever object it used to refer to

bool operator == (const this_type& V)

Returns true if both TRefCounter's point to the same peice of internal data

bool operator != (const this_type& V)

Returns true if both TRefCounter's don't point to the same piece of internal data

operator ref_data& ()

This operator allows you to perform operations on the TRefCounter as if it were the object that it wrapped

TRefCounter<ref_data&> operator = (const ref_data& V)

Assigning a data object to this object will copy to the internal data wrapped by this reference counter.

void Clear()

Removes reference to current data and creates a new, unique peice of data to refer to

void Unhook()

Like clear but it won't delete the reference data.

ref_data& GetData()

Returns the data object

const ref_data& GetData() const

Returns the data object (const)

int GetRefCount() const

Returns the number of objects refering to this data object

void AddRef()

Add a reference to this data object

bool CanDelete() const

Check if this data object is deletable

void RemoveRef()

Remove a reference to this data object

void SetData(const ref_data& _data)

Assign to the data object referred to by this object.

Documentation

A template class that can be used to implement reference counting.

Example:

	class TestClassData {
	public:
		int type, id;
	};
	
	class TestClass {
	public:
		TestClass(const TestClass& V) { // copy constructor
			ref = V.ref;
		}
		
		int GetType() 	{ return ref.GetData().type; }
		int GetID() 	{ return ref.GetData().id; }
	protected:
		TRefCounter<TestClassData> ref;
	};

In this example TestClass reference counts TestClassData. It is very plausible (and in fact very simple), for a class to referece count multiple data classes. Just use two or more TRefCounter members and copy them in the copy constructor.

Template arguments:

• ref_data The actual object to be reference counted
• CreateData A functor that takes one argument, a ref_data. This should be used to perform any initialization required by the object. While in most cases, you can pack the all of this into the ref_data's constructor/destructor, that is impossible if ref_data is an abstract class. (Optional)
• DestroyData A functor that takes one argument, a ref_data object. This can be used to perform any clean up required by the ref_data object. This is helpful if ref_data is a dynamically allocated object and needs to have its memory freed. (Optional)

TRefCounter(CreateDataFunctor _create, DestroyDataFunctor _destroy)

Initialize a reference counter that refers to a new data object. Use these instances of the functor objects for creation and destruction.

virtual ~TRefCounter()

When a reference counter is destroyed, the data's reference count is decremented and if required, destroyed

this_type& operator = (const this_type& V)

Makes this reference counter into a refer to the data refered to by "V", first removing reference to whatever object it used to refer to

bool operator == (const this_type& V)

Returns true if both TRefCounter's point to the same peice of internal data

bool operator != (const this_type& V)

Returns true if both TRefCounter's don't point to the same piece of internal data

operator ref_data& ()

This operator allows you to perform operations on the TRefCounter as if it were the object that it wrapped

TRefCounter<ref_data&> operator = (const ref_data& V)

Assigning a data object to this object will copy to the internal data wrapped by this reference counter. What this means is:

RefCounterObject = RefDataObject

will actually assign to the ref data stored in the RefCounterObject.

void Clear()

Removes reference to current data and creates a new, unique peice of data to refer to

void Unhook()

Like clear but it won't delete the reference data. This is a very dangerous function that should only be used when you know exactly what your doing. In most cases, what you really want is Clear. This function can be useful, if the ref data is unique and you want to use it outside of the reference counter. You can then "unhook" it to prevent the reference counter from automatically destroying it.

ref_data& GetData()

Returns the data object

const ref_data& GetData() const

Returns the data object (const)

int GetRefCount() const

Returns the number of objects refering to this data object

void AddRef()

Add a reference to this data object

bool CanDelete() const

Check if this data object is deletable

void RemoveRef()

Remove a reference to this data object

void SetData(const ref_data& _data)

Assign to the data object referred to by this object. This of course affects all reference counters that refer to the same data object as this one.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java