adtf::ucom::ant::iobject_ptr_base< T > Class Template Reference

Base class for iobject_ptr<T> defining their commonly used interface methods. More...

#include <object_ptr_intf.h>

Inherited by adtf::ucom::ant::iobject_ptr< ifunction< Signature > >, adtf::ucom::ant::iobject_ptr< INTERFACE_TYPE >, adtf::ucom::ant::iobject_ptr< const T >, and adtf::ucom::ant::iobject_ptr< T >.

Public Types
typedef T	element_type
	Contained type to manage an object of.

Public Member Functions
virtual T *	Get () const =0
	Get raw pointer to shared object.
virtual tResult	Reset (const iobject_ptr< T > &i_oOther)=0
	Reset this object_ptr<> with the content of another iobject_ptr<>
virtual T *	operator-> () const =0
	Operator-> overload to treat object_ptr<> types like real pointers.
virtual detail::iobject_ptr_ref< size_t > *	GetObjPtrRef () const =0
T &	operator* () const noexcept
	Operator* to dereference the stored pointer.

Protected Member Functions
	~iobject_ptr_base ()=default
	Destructor.

Detailed Description

template<typename T>
class adtf::ucom::ant::iobject_ptr_base< T >

Base class for iobject_ptr<T> defining their commonly used interface methods.

Template Parameters

T	Type of the managed resource. Must be derived from IObject

Member Function Documentation

Get()

template<typename T>

virtual T * adtf::ucom::ant::iobject_ptr_base< T >::Get ( ) const

pure virtual

Get raw pointer to shared object.

Returns

Raw pointer to shared object

Implemented in adtf::ucom::ant::detail::object_ptr_delegate_base< T, StorageType >, adtf::ucom::ant::detail::object_ptr_delegate_base< const IObject, StorageType >, adtf::ucom::ant::detail::object_ptr_delegate_base< IObject, StorageType >, and adtf::ucom::ant::detail::object_ptr_delegate_base< IObject, StorageType >.

operator*()

template<typename T>

T & adtf::ucom::ant::iobject_ptr_base< T >::operator* ( ) const

inlinenoexcept

Operator* to dereference the stored pointer.

Returns

Reference to the shared object

operator->()

template<typename T>

virtual T * adtf::ucom::ant::iobject_ptr_base< T >::operator-> ( ) const

pure virtual

Operator-> overload to treat object_ptr<> types like real pointers.

Returns

Pointer to shared object

Implemented in adtf::ucom::ant::detail::object_ptr_delegate_base< T, StorageType >, adtf::ucom::ant::detail::object_ptr_delegate_base< const IObject, StorageType >, adtf::ucom::ant::detail::object_ptr_delegate_base< IObject, StorageType >, and adtf::ucom::ant::detail::object_ptr_delegate_base< IObject, StorageType >.

Reset()

template<typename T>

virtual tResult adtf::ucom::ant::iobject_ptr_base< T >::Reset ( const iobject_ptr< T > & i_oOther )

pure virtual

Reset this object_ptr<> with the content of another iobject_ptr<>

Parameters

[in]

i_oOther

Contains the shared object to reset this type with

Postcondition

Reference counter increased by one. If another object is already managed, the reference count for this object gets decreased by one.

Returns

Standard error code.

Return values

ERR_NOERROR	Everything went fine
ERR_NO_INTERFACE	Managed resource owned by i_oOther does not expose interface type T. *this is reset to nullptr

Implemented in adtf::ucom::ant::detail::object_ptr_delegate_base< T, StorageType >, and adtf::ucom::ant::detail::object_ptr_delegate_base< const IObject, StorageType >.

---

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

• src/libraries/ucom3/include/adtfucom3/object_ptr/object_ptr_intf.h