lunchbox::RefPtr< T > Class Template Reference

A smart reference pointer, aka boost::intrusive_ptr. More...

#include <refPtr.h>

Collaboration diagram for lunchbox::RefPtr< T >:

Public Member Functions
	RefPtr ()
	Construct a new, empty reference pointer.
	RefPtr (T *const ptr)
	Construct a reference pointer from a C pointer.
	RefPtr (const RefPtr &from)
	Construct a copy of a reference pointer.
template<class O >
	RefPtr (RefPtr< O > from)
	Construct a copy of a reference pointer of a different type.
	~RefPtr ()
	Destruct this reference pointer.
RefPtr &	operator= (const RefPtr &rhs)
	Assign another RefPtr to this reference pointer.
RefPtr &	operator= (T *ptr)
	Assign a C pointer to this reference pointer.
bool	operator== (const RefPtr &rhs) const
bool	operator!= (const RefPtr &rhs) const
	operator bool_t () const
bool	operator< (const RefPtr &rhs) const
bool	operator> (const RefPtr &rhs) const
bool	operator! () const
bool	operator== (const T *ptr) const
bool	operator!= (const T *ptr) const
T *	operator-> ()
	Access the held object.
const T *	operator-> () const
	Access the held object.
T &	operator* ()
	Access the held object.
const T &	operator* () const
	Access the held object.
T *	get ()
const T *	get () const
bool	isValid () const

Detailed Description

template<class T>
class lunchbox::RefPtr< T >

A smart reference pointer, aka boost::intrusive_ptr.

Relies on the held object to implement ref() and unref() correctly.

Definition at line 34 of file refPtr.h.

Constructor & Destructor Documentation

template<class T>

lunchbox::RefPtr< T >::RefPtr ( )

inline

Construct a new, empty reference pointer.

Version

1.0

Definition at line 40 of file refPtr.h.

template<class T>

lunchbox::RefPtr< T >::RefPtr ( T *const  ptr )

inline

Construct a reference pointer from a C pointer.

Version

1.0

Definition at line 43 of file refPtr.h.

template<class T>

lunchbox::RefPtr< T >::RefPtr ( const RefPtr< T > &  from )

inline

Construct a copy of a reference pointer.

Version

1.0

Definition at line 46 of file refPtr.h.

template<class T>

template<class O >

lunchbox::RefPtr< T >::RefPtr ( RefPtr< O >  from )

inline

Construct a copy of a reference pointer of a different type.

Version

1.0

Definition at line 52 of file refPtr.h.

template<class T>

lunchbox::RefPtr< T >::~RefPtr ( )

inline

Destruct this reference pointer.

Version

1.0

Definition at line 56 of file refPtr.h.

Member Function Documentation

template<class T>

T* lunchbox::RefPtr< T >::get ( )

inline

Returns

the C pointer.

Version

1.0

Definition at line 147 of file refPtr.h.

Referenced by lunchbox::PerThreadRef< T >::operator=().

Here is the caller graph for this function:

template<class T>

const T* lunchbox::RefPtr< T >::get ( ) const

inline

Returns

the C pointer.

Version

1.0

Definition at line 149 of file refPtr.h.

template<class T>

bool lunchbox::RefPtr< T >::isValid ( ) const

inline

Returns

true if the RefPtr holds a non-0 pointer.

Version

1.0

Definition at line 152 of file refPtr.h.

template<class T>

lunchbox::RefPtr< T >::operator bool_t ( ) const

inline

Returns

true if a pointer is held, false otherwise.

Version

1.1.5

Definition at line 102 of file refPtr.h.

template<class T>

bool lunchbox::RefPtr< T >::operator! ( ) const

inline

Returns

true if the RefPtr is empty.

Version

1.0

Definition at line 119 of file refPtr.h.

template<class T>

bool lunchbox::RefPtr< T >::operator!= ( const RefPtr< T > &  rhs ) const

inline

Returns

true if both reference pointer hold different C pointer.

Version

1.0

Definition at line 95 of file refPtr.h.

template<class T>

bool lunchbox::RefPtr< T >::operator!= ( const T *  ptr ) const

inline

Returns

true if the reference pointers does not hold the C pointer

Version

1.0

Definition at line 131 of file refPtr.h.

template<class T>

T& lunchbox::RefPtr< T >::operator* ( )

inline

Access the held object.

Version

1.0

Definition at line 140 of file refPtr.h.

References lunchbox::className().

Here is the call graph for this function:

template<class T>

const T& lunchbox::RefPtr< T >::operator* ( ) const

inline

Access the held object.

Version

1.0

Definition at line 143 of file refPtr.h.

References lunchbox::className().

Here is the call graph for this function:

template<class T>

T* lunchbox::RefPtr< T >::operator-> ( )

inline

Access the held object.

Version

1.0

Definition at line 134 of file refPtr.h.

References lunchbox::className().

Here is the call graph for this function:

template<class T>

const T* lunchbox::RefPtr< T >::operator-> ( ) const

inline

Access the held object.

Version

1.0

Definition at line 137 of file refPtr.h.

References lunchbox::className().

Here is the call graph for this function:

template<class T>

bool lunchbox::RefPtr< T >::operator< ( const RefPtr< T > &  rhs ) const

inline

Returns

true if the left RefPtr is smaller then the right.

Version

1.0

Definition at line 108 of file refPtr.h.

template<class T>

RefPtr& lunchbox::RefPtr< T >::operator= ( const RefPtr< T > &  rhs )

inline

Assign another RefPtr to this reference pointer.

Version

1.0

Definition at line 59 of file refPtr.h.

template<class T>

RefPtr& lunchbox::RefPtr< T >::operator= ( T *  ptr )

inline

Assign a C pointer to this reference pointer.

Version

1.0

Definition at line 72 of file refPtr.h.

template<class T>

bool lunchbox::RefPtr< T >::operator== ( const RefPtr< T > &  rhs ) const

inline

Returns

true if both reference pointers hold the same C pointer.

Version

1.0

Definition at line 88 of file refPtr.h.

template<class T>

bool lunchbox::RefPtr< T >::operator== ( const T *  ptr ) const

inline

Returns

true if the reference pointers holds the C pointer.

Version

1.0

Definition at line 125 of file refPtr.h.

template<class T>

bool lunchbox::RefPtr< T >::operator> ( const RefPtr< T > &  rhs ) const

inline

Returns

true if the right RefPtr is smaller then the left.

Version

1.0

Definition at line 115 of file refPtr.h.

---

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

• refPtr.h