fsdk::Ref< T > Struct Template Reference

Smart pointer for reference counted objects. More...

#include <Ref.h>

Inheritance diagram for fsdk::Ref< T >:

Public Member Functions
	Ref () noexcept=default
	Constructor. Initializes object pointer to nullptr.
	Ref (std::nullptr_t) noexcept
	Initializes object pointer to nullptr.
	Ref (T *ptr) noexcept
	Initializes object pointer with ptr and retains a reference.
	Ref (const Ref &other)
	Initializes object pointer with other and retains a reference.
template<class D , typename = typename std::enable_if<std::is_convertible<D*, T*>::value>::type>
	Ref (const Ref< D > &other)
	Initializes object pointer with other and retains a reference.
	~Ref () noexcept
	Releases reference being held (if any).
T *	operator-> () const noexcept
	Access pointer.
T **	getInitReference () noexcept
	Access pointer for initialization.
bool	operator== (const Ref &other) const noexcept
	Check if two refs are the same.
bool	operator!= (const Ref &other) const noexcept
	Check if two refs are not the same.
Ref &	operator= (const Ref &other) noexcept
	Assign a strong reference.
template<class D , typename = typename std::enable_if<std::is_convertible<D*, T*>::value>::type>
Ref &	operator= (const Ref< D > &other) noexcept
	Assign a strong reference.
Ref &	operator= (T *ptr) noexcept
	Assign a raw pointer.
Ref &	operator= (std::nullptr_t) noexcept
	Assign a nullptr_t.
Ref &	assign (T *ptr) noexcept
	Assign an object. Presumes shared ownership, increases reference count.
Ref &	acquire (T *ptr) noexcept
	Acquire ownership of the object.
Ref &	make_ref (T *ptr) noexcept
	Create ref without acquiring ownership.
T *	reset () noexcept
	Reset reference counted object and assign nullptr to the pointer.
template<typename S >
Ref< S >	as () const noexcept
	Make smart reference with relative type.
Public Member Functions inherited from fsdk::RefBase< T >
	RefBase () noexcept=default
	Initializes object pointer to nullptr.
	RefBase (T *ptr) noexcept
	Initializes object pointer with ptr.
	operator T* () const noexcept
	Get raw object pointer.
T &	operator* () const noexcept
	Dereference operator.
	operator bool () const noexcept
	Implicit cast to bool.
bool	operator== (const RefBase &other) const noexcept
	Check if two refs are the same.
bool	operator!= (const RefBase &other) const noexcept
	Check if two refs are not the same.
bool	isNull () const noexcept
	Check for nullptr.
bool	isExpired () const noexcept
	Check is object is dead.
bool	isUnique () const noexcept
	Check if object has only one strong reference.
T *	get () const noexcept
	Get current raw object pointer.
void	set (T *ptr) noexcept
	Replace object pointer without any checks or reference management.

Additional Inherited Members
Protected Attributes inherited from fsdk::RefBase< T >
T *	m_ptr {nullptr}
	Raw pointer.

Detailed Description

template<typename T>
struct fsdk::Ref< T >

Smart pointer for reference counted objects.

Automatically calls retain/release and provides safety assertions.

Template Parameters

T	object interface (must be derived from IRefCounted)

Constructor & Destructor Documentation

Ref() [1/3]

template<typename T >

fsdk::Ref< T >::Ref ( T * ptr )

inlineexplicitnoexcept

Initializes object pointer with ptr and retains a reference.

Note

this shares ownership.

Parameters

[in]

ptr

raw pointer to initialize with.

Ref() [2/3]

template<typename T >

fsdk::Ref< T >::Ref ( const Ref< T > & other )

inline

Initializes object pointer with other and retains a reference.

Note

this shares ownership.

Parameters

[in]

other

pointer to initialize with.

Ref() [3/3]

template<typename T >

template<class D , typename = typename std::enable_if<std::is_convertible<D*, T*>::value>::type>

fsdk::Ref< T >::Ref ( const Ref< D > & other )

inlineexplicit

Initializes object pointer with other and retains a reference.

Note

this shares ownership.

Parameters

[in]

other

pointer of derived template class to initialize with.

Member Function Documentation

acquire()

template<typename T >

Ref & fsdk::Ref< T >::acquire ( T * ptr )

inlinenoexcept

Acquire ownership of the object.

Parameters

[in]

ptr

raw object pointer to acquire.

as()

template<typename T >

template<typename S >

Ref< S > fsdk::Ref< T >::as ( ) const

inlinenoexcept

Make smart reference with relative type.

Template Parameters

S	target interface (must be relative to T)

assign()

template<typename T >

Ref & fsdk::Ref< T >::assign ( T * ptr )

inlinenoexcept

Assign an object. Presumes shared ownership, increases reference count.

Parameters

[in]

ptr

raw object pointer to assign.

getInitReference()

template<typename T >

T ** fsdk::Ref< T >::getInitReference ( )

inlinenoexcept

Access pointer for initialization.

Note

previously held pointer is released.

Returns

pointer to pointer to object.

make_ref()

template<typename T >

Ref & fsdk::Ref< T >::make_ref ( T * ptr )

inlinenoexcept

Create ref without acquiring ownership.

Parameters

[in]

ptr

raw object pointer.

operator!=()

template<typename T >

bool fsdk::Ref< T >::operator!= ( const Ref< T > & other ) const

inlinenoexcept

Check if two refs are not the same.

Returns

true if two refs are not the same.

Parameters

[in]

other

ref to check against.

operator->()

template<typename T >

T * fsdk::Ref< T >::operator-> ( ) const

inlinenoexcept

Access pointer.

Note

pointer is checked for null in runtime.

Returns

pointer to object.

operator=() [1/4]

template<typename T >

Ref & fsdk::Ref< T >::operator= ( const Ref< T > & other )

inlinenoexcept

Assign a strong reference.

Parameters

[in]

other

strong reference.

Returns

reference.

operator=() [2/4]

template<typename T >

template<class D , typename = typename std::enable_if<std::is_convertible<D*, T*>::value>::type>

Ref & fsdk::Ref< T >::operator= ( const Ref< D > & other )

inlinenoexcept

Assign a strong reference.

Parameters

[in]

other

strong reference of derived template class.

Returns

reference.

operator=() [3/4]

template<typename T >

Ref & fsdk::Ref< T >::operator= ( std::nullptr_t )

inlinenoexcept

Assign a nullptr_t.

Note

this releases previously held reference (if any).

Returns

reference.

operator=() [4/4]

template<typename T >

Ref & fsdk::Ref< T >::operator= ( T * ptr )

inlinenoexcept

Assign a raw pointer.

Note

this shares ownership.

Parameters

[in]

ptr

raw pointer.

Returns

reference.

operator==()

template<typename T >

bool fsdk::Ref< T >::operator== ( const Ref< T > & other ) const

inlinenoexcept

Check if two refs are the same.

Returns

true if two refs are the same.

Parameters

[in]

other

ref to check against.

---

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

• fsdk.framework/Headers/Types/Ref.h