VgEngine::VgReferenced Class Reference

The VgReferenced class owns the number of references of an object. More...

Inheritance diagram for VgEngine::VgReferenced:

Public Member Functions
	VgReferenced ()
	Constructor. More...
	VgReferenced (const VgReferenced &pThis)
	Copy constructor. More...
virtual	~VgReferenced ()
	Destructor. More...
VgReferenced &	operator= (const VgReferenced &pThis)
	Assignment operator. More...
void	ref () const
	This method is used to add a reference to this object. More...
int	unref () const
	This method is used to remove a reference to this object. More...
int	getNbReferences () const
	Retrieves the number of references to this object. More...

Protected Attributes
int	mNbReferences
	The number of references to this object. More...

Detailed Description

The VgReferenced class owns the number of references of an object.

It is in charge of deleting the object when there is not more references. To learn more about its usage look at the VgRefPtr documentation.

Date

12/04/2010

Constructor & Destructor Documentation

VgEngine::VgReferenced::VgReferenced

(

)

Constructor.

VgEngine::VgReferenced::VgReferenced

(

const VgReferenced &

pThis

)

Copy constructor.

virtual VgEngine::VgReferenced::~VgReferenced ( )

virtual

Destructor.

Member Function Documentation

int VgEngine::VgReferenced::getNbReferences

(

)

const

Retrieves the number of references to this object.

VgReferenced& VgEngine::VgReferenced::operator=

(

const VgReferenced &

pThis

)

Assignment operator.

void VgEngine::VgReferenced::ref

(

)

const

This method is used to add a reference to this object.

Only VgRefPtr should call this method unless the caller exactly know what he is doing.

int VgEngine::VgReferenced::unref

(

)

const

This method is used to remove a reference to this object.

When the object has no more references VgRefPtr will delete it. Only VgRefPtr should call this method unless the caller exactly know what he is doing.

Returns

the updated number of references left

Member Data Documentation

int VgEngine::VgReferenced::mNbReferences

mutableprotected

The number of references to this object.

---

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

• VgReferenced.h