C++ class EScript::_CountedRef
_{template< class _T >}
_CountedRef

public

Inheritance Graph

graph BT
	_CountedRef
	ERef --> _CountedRef
	ERef --> _CountedRef
	ERef --> _CountedRef
	ERef --> _CountedRef
	ERef --> _CountedRef
	ERef --> _CountedRef
	ERef --> _CountedRef
	ERef --> _CountedRef
	ERef --> _CountedRef
	click _CountedRef "classEScript_1_1__CountedRef"
	click ERef "classEScript_1_1ERef"
	click ERef "classEScript_1_1ERef"
	click ERef "classEScript_1_1ERef"
	click ERef "classEScript_1_1ERef"
	click ERef "classEScript_1_1ERef"
	click ERef "classEScript_1_1ERef"
	click ERef "classEScript_1_1ERef"
	click ERef "classEScript_1_1ERef"
	click ERef "classEScript_1_1ERef"

Description

Simple (counted) reference to use with EReferenceCounter .

Information

_T *	get() const Returns a pointer to the referenced Object .
_T *	operator->() const Direct access to the referenced Object .
bool	isNull() const Returns true if the referenced object is nullptr.
bool	isNotNull() const Returns true if the referenced object is not nullptr.
	operator bool() const
bool	operator==(const _CountedRef & other) const
bool	operator==(const _Ptr < _T > & other) const
bool	operator==(const _T * o2) const
bool	operator!=(const _CountedRef & other) const
bool	operator!=(const _Ptr < _T > & other) const
bool	operator!=(const _T * o2) const

Public Functions

	_CountedRef()
	_CountedRef(_T * _obj)
	_CountedRef(const _CountedRef & other)
	_CountedRef( _CountedRef && other)
	_CountedRef(const _Ptr < _T > & other)
	~_CountedRef()
void	_set(_T * _obj) Just set; dont touch the counter.
_CountedRef &	operator=(const _CountedRef & other) Assignment.
_CountedRef &	operator=(_T * _obj) Assignment.
_CountedRef &	operator=( _CountedRef && other) Assignment.
_T *	detach()
_T *	detachAndDecrease()
void	swap( _CountedRef & other) Swap the referenced pointers without touching the reference counter.

---

Documentation

function
EScript::_CountedRef::get

public

const

inline

_T * get(	) const

Returns a pointer to the referenced Object .

_{Defined in EScript/EScript/Utils/ObjRef.h:90}

---

function
EScript::_CountedRef::operator->

public

const

inline

_T * operator->(	) const

Direct access to the referenced Object .

_{Defined in EScript/EScript/Utils/ObjRef.h:93}

---

function
EScript::_CountedRef::isNull

public

const

inline

bool isNull(	) const

Returns true if the referenced object is nullptr.

_{Defined in EScript/EScript/Utils/ObjRef.h:96}

---

function
EScript::_CountedRef::isNotNull

public

const

inline

bool isNotNull(	) const

Returns true if the referenced object is not nullptr.

_{Defined in EScript/EScript/Utils/ObjRef.h:99}

---

function
EScript::_CountedRef::operator bool

public

const

inline

explicit

operator bool(	) const

_{Defined in EScript/EScript/Utils/ObjRef.h:101}

---

function
EScript::_CountedRef::operator==

public

const

inline

bool operator==(	const _CountedRef &	other ) const

_{Defined in EScript/EScript/Utils/ObjRef.h:103}

---

function
EScript::_CountedRef::operator==

public

const

inline

bool operator==(	const _Ptr < _T > &	other ) const

_{Defined in EScript/EScript/Utils/ObjRef.h:104}

---

function
EScript::_CountedRef::operator==

public

const

inline

bool operator==(	const _T *	o2 ) const

_{Defined in EScript/EScript/Utils/ObjRef.h:105}

---

function
EScript::_CountedRef::operator!=

public

const

inline

bool operator!=(	const _CountedRef &	other ) const

_{Defined in EScript/EScript/Utils/ObjRef.h:106}

---

function
EScript::_CountedRef::operator!=

public

const

inline

bool operator!=(	const _Ptr < _T > &	other ) const

_{Defined in EScript/EScript/Utils/ObjRef.h:107}

---

function
EScript::_CountedRef::operator!=

public

const

inline

bool operator!=(	const _T *	o2 ) const

_{Defined in EScript/EScript/Utils/ObjRef.h:108}

---

function
EScript::_CountedRef::_CountedRef

public

inline

_CountedRef(	)

_{Defined in EScript/EScript/Utils/ObjRef.h:24}

---

function
EScript::_CountedRef::_CountedRef

public

inline

_CountedRef(	_T *	_obj )

_{Defined in EScript/EScript/Utils/ObjRef.h:25}

---

function
EScript::_CountedRef::_CountedRef

public

inline

_CountedRef(	const _CountedRef &	other )

_{Defined in EScript/EScript/Utils/ObjRef.h:26}

---

function
EScript::_CountedRef::_CountedRef

public

inline

_CountedRef(	_CountedRef &&	other )

_{Defined in EScript/EScript/Utils/ObjRef.h:27}

---

function
EScript::_CountedRef::_CountedRef

public

inline

_CountedRef(	const _Ptr < _T > &	other )

_{Defined in EScript/EScript/Utils/ObjRef.h:28}

---

function
EScript::_CountedRef::~_CountedRef

public

inline

~_CountedRef(	)

_{Defined in EScript/EScript/Utils/ObjRef.h:30}

---

function
EScript::_CountedRef::_set

public

inline

void _set(	_T *	_obj )

Just set; dont touch the counter.

_{Defined in EScript/EScript/Utils/ObjRef.h:33}

---

function
EScript::_CountedRef::operator=

public

inline

_CountedRef & operator=(	const _CountedRef &	other )

Assignment.

_{Defined in EScript/EScript/Utils/ObjRef.h:36}

---

function
EScript::_CountedRef::operator=

public

inline

_CountedRef & operator=(	_T *	_obj )

Assignment.

_{Defined in EScript/EScript/Utils/ObjRef.h:46}

---

function
EScript::_CountedRef::operator=

public

inline

_CountedRef & operator=(	_CountedRef &&	other )

Assignment.

_{Defined in EScript/EScript/Utils/ObjRef.h:56}

---

function
EScript::_CountedRef::detach

public

inline

_T * detach(	)

Detach the object from the Reference without decreasing the reference counter or deleting the object; sets the Reference to nullptr.

_{Defined in EScript/EScript/Utils/ObjRef.h:64}

---

function
EScript::_CountedRef::detachAndDecrease

public

inline

_T * detachAndDecrease(	)

Detach the object from the Reference with decreasing the reference counter and set the Reference to nullptr. The object is not deletet if the counter reaches 0.

_{Defined in EScript/EScript/Utils/ObjRef.h:73}

---

function
EScript::_CountedRef::swap

public

inline

void swap(	_CountedRef &	other )

Swap the referenced pointers without touching the reference counter.

_{Defined in EScript/EScript/Utils/ObjRef.h:81}

---