VgEngine::VgRefPtr< Type > Class Template Reference

List of all members.

Public Member Functions
	VgRefPtr ()
	Constructor.
	VgRefPtr (Type *pPointer)
	Constructor.
	VgRefPtr (const VgRefPtr &pRefPtr)
	Copy constructor.
template<class OtherType >
	VgRefPtr (const VgRefPtr< OtherType > &pRefPtr)
	Cross-type constructor.
	~VgRefPtr ()
	Destructor.
	operator VgEngine::VgConstRefPtr< Type > ()
	Conversion operator to VgConstRefPtr.
	operator VgEngine::VgConstRefPtr< Type > () const
	Conversion operator to VgConstRefPtr.
template<typename OtherType >
	operator VgEngine::VgConstRefPtr< OtherType > () const
	Cross-type conversion operator to VgConstRefPtr.
VgRefPtr &	operator= (const VgRefPtr &pRefPtr)
	Assignation operator.
template<class OtherType >
VgRefPtr< Type > &	operator= (const VgRefPtr< OtherType > &pRefPtr)
	Cross-type assignation operator.
VgRefPtr &	set (Type *pPointer)
VgRefPtr &	operator= (Type *pPointer)
	Assignation operator with a pointer.
bool	operator== (const VgRefPtr &pRefPtr) const
	Equal to operator (VgRefPtr acts like a pointer).
bool	operator== (const Type *pPointer) const
	Equal to operator (VgRefPtr acts like a pointer).
bool	operator!= (const VgRefPtr &pRefPtr) const
	Not equal to operator (VgRefPtr acts like a pointer).
bool	operator!= (const Type *pPointer) const
	Not equal to operator (VgRefPtr acts like a pointer).
bool	operator< (const VgRefPtr &pRefPtr) const
	Greater than operator (VgRefPtr acts like a pointer).
Type &	operator* () const
	Dereference the pointer.
Type *	operator-> () const
	Allow the access to encapsulated pointer's members.
Type *	get () const
	Retrieves the encapsulated pointer.
bool	operator! () const
	Logical negation operator (used to test the pointer validity).
bool	isValid () const
	Tell if the pointer is valid.
	operator bool ()
Static Public Member Functions
static VgRefPtr< Type >	getNull ()
Friends
class	VgEngine::VgObjectBridge
class	VgConstRefPtr
class	VgRefPtr
bool	operator== (const Type *pPointer, const VgRefPtr &pRefPtr)
	Equal to operator (VgRefPtr acts like a pointer).
bool	operator!= (const Type *pPointer, const VgRefPtr &pRefPtr)
	Not equal to operator (VgRefPtr acts like a pointer).

template<class Type>
class VgEngine::VgRefPtr< Type >

---

Constructor & Destructor Documentation

template<class Type>

VgEngine::VgRefPtr< Type >::VgRefPtr

(

)

[inline]

Constructor.

template<class Type>

VgEngine::VgRefPtr< Type >::VgRefPtr

(

Type *

pPointer )

[inline]

Constructor.

template<class Type>

VgEngine::VgRefPtr< Type >::VgRefPtr

(

const VgRefPtr< Type > &

pRefPtr )

[inline]

Copy constructor.

template<class Type>

template<class OtherType >

VgEngine::VgRefPtr< Type >::VgRefPtr

(

const VgRefPtr< OtherType > &

pRefPtr )

[inline]

Cross-type constructor.

template<class Type>

VgEngine::VgRefPtr< Type >::~VgRefPtr

(

)

[inline]

Destructor.

---

Member Function Documentation

template<class Type>

Type* VgEngine::VgRefPtr< Type >::get

(

)

const [inline]

Retrieves the encapsulated pointer.

template<class Type>

static VgRefPtr<Type> VgEngine::VgRefPtr< Type >::getNull

(

)

[inline, static]

template<class Type>

bool VgEngine::VgRefPtr< Type >::isValid

(

)

const [inline]

Tell if the pointer is valid.

template<class Type>

VgEngine::VgRefPtr< Type >::operator bool

(

)

[inline]

template<class Type>

template<typename OtherType >

VgEngine::VgRefPtr< Type >::operator VgEngine::VgConstRefPtr< OtherType >

(

)

const [inline]

Cross-type conversion operator to VgConstRefPtr.

template<class Type>

VgEngine::VgRefPtr< Type >::operator VgEngine::VgConstRefPtr< Type >

(

)

const [inline]

Conversion operator to VgConstRefPtr.

template<class Type>

VgEngine::VgRefPtr< Type >::operator VgEngine::VgConstRefPtr< Type >

(

)

[inline]

Conversion operator to VgConstRefPtr.

template<class Type>

bool VgEngine::VgRefPtr< Type >::operator!

(

)

const [inline]

Logical negation operator (used to test the pointer validity).

template<class Type>

bool VgEngine::VgRefPtr< Type >::operator!=

(

const VgRefPtr< Type > &

pRefPtr )

const [inline]

Not equal to operator (VgRefPtr acts like a pointer).

template<class Type>

bool VgEngine::VgRefPtr< Type >::operator!=

(

const Type *

pPointer )

const [inline]

Not equal to operator (VgRefPtr acts like a pointer).

template<class Type>

Type& VgEngine::VgRefPtr< Type >::operator*

(

)

const [inline]

Dereference the pointer.

template<class Type>

Type* VgEngine::VgRefPtr< Type >::operator->

(

)

const [inline]

Allow the access to encapsulated pointer's members.

template<class Type>

bool VgEngine::VgRefPtr< Type >::operator<

(

const VgRefPtr< Type > &

pRefPtr )

const [inline]

Greater than operator (VgRefPtr acts like a pointer).

template<class Type>

template<class OtherType >

VgRefPtr< Type >& VgEngine::VgRefPtr< Type >::operator=

(

const VgRefPtr< OtherType > &

pRefPtr )

[inline]

Cross-type assignation operator.

template<class Type>

VgRefPtr& VgEngine::VgRefPtr< Type >::operator=

(

Type *

pPointer )

[inline]

Assignation operator with a pointer.

template<class Type>

VgRefPtr& VgEngine::VgRefPtr< Type >::operator=

(

const VgRefPtr< Type > &

pRefPtr )

[inline]

Assignation operator.

template<class Type>

bool VgEngine::VgRefPtr< Type >::operator==

(

const Type *

pPointer )

const [inline]

Equal to operator (VgRefPtr acts like a pointer).

template<class Type>

bool VgEngine::VgRefPtr< Type >::operator==

(

const VgRefPtr< Type > &

pRefPtr )

const [inline]

Equal to operator (VgRefPtr acts like a pointer).

template<class Type>

VgRefPtr& VgEngine::VgRefPtr< Type >::set

(

Type *

pPointer )

[inline]

---

Friends And Related Function Documentation

template<class Type>

bool operator!=	(	const Type *	pPointer,
		const VgRefPtr< Type > &	pRefPtr
	)		[friend]

Not equal to operator (VgRefPtr acts like a pointer).

template<class Type>

bool operator==	(	const Type *	pPointer,
		const VgRefPtr< Type > &	pRefPtr
	)		[friend]

Equal to operator (VgRefPtr acts like a pointer).

template<class Type>

friend class VgConstRefPtr [friend]

template<class Type>

friend class VgEngine::VgObjectBridge [friend]

template<class Type>

friend class VgRefPtr [friend]

---

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

• VgRefPtr.h