VgEngine::VgConstRefPtr< Type > Class Template Reference

Public Member Functions
	VgConstRefPtr ()
	VgConstRefPtr (Type const *pPointer)
	VgConstRefPtr (const VgConstRefPtr &pConstRefPtr)
template<class OtherType >
	VgConstRefPtr (const VgConstRefPtr< OtherType > &pConstRefPtr)
	~VgConstRefPtr ()
VgConstRefPtr &	operator= (const VgConstRefPtr &pConstRefPtr)
template<class OtherType >
VgConstRefPtr< Type > &	operator= (const VgConstRefPtr< OtherType > &pConstRefPtr)
template<typename OtherType >
	operator VgConstRefPtr< OtherType > ()
VgConstRefPtr &	set (Type const *pPointer)
VgConstRefPtr &	operator= (Type const *pPointer)
bool	operator== (const VgConstRefPtr &pConstRefPtr) const
bool	operator== (Type const *pPointer) const
bool	operator!= (const VgConstRefPtr &pRefPtr) const
bool	operator!= (Type const *pPointer) const
bool	operator< (const VgConstRefPtr &pRefPtr) const
Type const &	operator* () const
Type const *	operator-> () const
Type const *	get () const
bool	operator! () const
bool	isValid () const
	operator bool ()

Static Public Member Functions
static VgConstRefPtr< Type >	getNull ()

Friends
class	VgEngine::VgObjectBridge
template<typename >
class	VgConstRefPtr
template<typename >
class	VgRefPtr
bool	operator== (Type const *pPointer, const VgConstRefPtr &pRefPtr)
bool	operator!= (Type const *pPointer, const VgConstRefPtr< Type > &pRefPtr)

Detailed Description

template<typename Type>
class VgEngine::VgConstRefPtr< Type >

The VgConstRefPtr is the 'const' version of the VgRefPtr template.

Template Parameters

Type	The type wrapped by the VgRefPtr.

Constructor & Destructor Documentation

template<typename Type>

VgEngine::VgConstRefPtr< Type >::VgConstRefPtr ( )

inline

Constructor.

template<typename Type>

VgEngine::VgConstRefPtr< Type >::VgConstRefPtr ( Type const *  pPointer )

inline

Constructor.

template<typename Type>

VgEngine::VgConstRefPtr< Type >::VgConstRefPtr ( const VgConstRefPtr< Type > &  pConstRefPtr )

inline

Copy constructor.

template<typename Type>

template<class OtherType >

VgEngine::VgConstRefPtr< Type >::VgConstRefPtr ( const VgConstRefPtr< OtherType > &  pConstRefPtr )

inline

Cross-type constructor.

template<typename Type>

VgEngine::VgConstRefPtr< Type >::~VgConstRefPtr ( )

inline

Destructor.

Member Function Documentation

template<typename Type>

Type const* VgEngine::VgConstRefPtr< Type >::get ( ) const

inline

Retrieves the encapsulated pointer.

template<typename Type>

static VgConstRefPtr<Type> VgEngine::VgConstRefPtr< Type >::getNull ( )

inlinestatic

template<typename Type>

bool VgEngine::VgConstRefPtr< Type >::isValid ( ) const

inline

Tell if the pointer is valid.

template<typename Type>

VgEngine::VgConstRefPtr< Type >::operator bool ( )

inline

template<typename Type>

template<typename OtherType >

VgEngine::VgConstRefPtr< Type >::operator VgConstRefPtr< OtherType > ( )

inline

template<typename Type>

bool VgEngine::VgConstRefPtr< Type >::operator! ( ) const

inline

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

template<typename Type>

bool VgEngine::VgConstRefPtr< Type >::operator!= ( const VgConstRefPtr< Type > &  pRefPtr ) const

inline

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

template<typename Type>

bool VgEngine::VgConstRefPtr< Type >::operator!= ( Type const *  pPointer ) const

inline

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

template<typename Type>

Type const& VgEngine::VgConstRefPtr< Type >::operator* ( ) const

inline

Dereference the pointer.

template<typename Type>

Type const* VgEngine::VgConstRefPtr< Type >::operator-> ( ) const

inline

Allow the access to encapsulated pointer's members.

template<typename Type>

bool VgEngine::VgConstRefPtr< Type >::operator< ( const VgConstRefPtr< Type > &  pRefPtr ) const

inline

Greater than operator (VgRefPtr acts like a pointer).

template<typename Type>

VgConstRefPtr& VgEngine::VgConstRefPtr< Type >::operator= ( const VgConstRefPtr< Type > &  pConstRefPtr )

inline

Assignation operator.

template<typename Type>

template<class OtherType >

VgConstRefPtr< Type >& VgEngine::VgConstRefPtr< Type >::operator= ( const VgConstRefPtr< OtherType > &  pConstRefPtr )

inline

Cross-type assignation operator.

template<typename Type>

VgConstRefPtr& VgEngine::VgConstRefPtr< Type >::operator= ( Type const *  pPointer )

inline

Assignation operator with a pointer.

template<typename Type>

bool VgEngine::VgConstRefPtr< Type >::operator== ( const VgConstRefPtr< Type > &  pConstRefPtr ) const

inline

Equal to operator (VgRefPtr acts like a pointer).

template<typename Type>

bool VgEngine::VgConstRefPtr< Type >::operator== ( Type const *  pPointer ) const

inline

Equal to operator (VgRefPtr acts like a pointer).

template<typename Type>

VgConstRefPtr& VgEngine::VgConstRefPtr< Type >::set ( Type const *  pPointer )

inline

Friends And Related Function Documentation

template<typename Type>

bool operator!= ( Type const *  pPointer, const VgConstRefPtr< Type > &  pRefPtr  )

friend

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

template<typename Type>

bool operator== ( Type const *  pPointer, const VgConstRefPtr< Type > &  pRefPtr  )

friend

Equal to operator (VgRefPtr acts like a pointer).

template<typename Type>

template<typename >

friend class VgConstRefPtr

friend

template<typename Type>

friend class VgEngine::VgObjectBridge

friend

template<typename Type>

template<typename >

friend class VgRefPtr

friend

---

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

• VgRefPtr.h