Ocean::Devices::SmartDeviceRef< T > Class Template Reference

This class implements a smart device reference. More...

#include <DeviceRef.h>

Inheritance diagram for Ocean::Devices::SmartDeviceRef< T >:

Public Member Functions
	SmartDeviceRef ()
	Creates an empty smart device reference.
	SmartDeviceRef (const DeviceRef &deviceRef)
	Creates a new smart device reference by a given device reference.
	SmartDeviceRef (Device *object)
	Creates a new SmartDeviceRef by a given object.
template<typename T2 >
	SmartDeviceRef (const SmartDeviceRef< T2 > &reference)
	Copies a smart device reference.
SmartDeviceRef &	operator= (const DeviceRef &deviceRef)
	Assigns a smart device reference.
Public Member Functions inherited from Ocean::SmartObjectRef< T, Device >
	SmartObjectRef ()=default
	Creates a new SmartObjectRef with no internal object.
	SmartObjectRef (T *object)
	Creates a new SmartObjectRef by a given object.
	SmartObjectRef (T *object, const ReleaseCallback &releaseCallback)
	Creates a new SmartObjectRef by a given object.
	SmartObjectRef (const SmartObjectRef< T, Device > &smartObjectRef)
	Copy constructor.
	SmartObjectRef (SmartObjectRef< T, Device > &&smartObjectRef)
	Move constructor.
	SmartObjectRef (const ObjectRef< Device > &objectRef)
	Creates a new SmartObjectRef by a given ObjectRef.
	SmartObjectRef (const SmartObjectRef< T2, Device > &smartObjectRef)
	Copies a SmartObjectRef object.
SmartObjectRef< T, Device > &	operator= (const SmartObjectRef< T, Device > &smartObjectRef)
	Assign operator.
SmartObjectRef< T, Device > &	operator= (SmartObjectRef< T, Device > &&smartObjectRef)
	Moves a smart object reference object to this smart object reference.
SmartObjectRef< T, Device > &	operator= (const ObjectRef< Device > &objectRef)
	Assigns a ObjectRef to this smart object reference.
void	release ()
	Releases the internal object, if any.
T *	pointer () const
	Returns a pointer to the objects that is encapsulated by this wrapper.
T *	operator-> () const
	Returns a point to the internal object if existing.
T &	operator* () const
	Returns a reference to the internal object if existing.
Public Member Functions inherited from Ocean::ObjectRef< T >
	ObjectRef ()=default
	Creates an empty ObjectRef object.
	ObjectRef (const ObjectRef< T > &objectRef)
	Copy constructor.
	ObjectRef (ObjectRef< T > &&object) noexcept
	Move constructor.
	ObjectRef (T *object)
	Creates a new ObjectRef holding a given object.
	ObjectRef (T *object, const ReleaseCallback &releaseCallback)
	Creates a new ObjectRef holding and managing a given object.
	~ObjectRef ()
	Destructs an object reference object and releases the internal object if possible.
template<typename T2 >
T2 &	force () const
	Returns a reference to the internal object forcing to a specified type.
T *	operator-> () const
	Returns a point to the internal object if existing.
T &	operator* () const
	Returns a reference to the internal object if existing.
bool	isUnique () const
	Returns whether there is no other object reference but this one.
bool	isNull () const
	Returns whether this object reference holds no internal object.
void	release ()
	Releases the internal object, if any.
T *	pointer () const
	Returns a pointer to the objects that is encapsulated by this wrapper.
ObjectRef< T > &	operator= (const ObjectRef< T > &objectRef)
	Assign operator.
ObjectRef< T > &	operator= (ObjectRef< T > &&right) noexcept
	Move operator.
bool	operator== (const ObjectRef< T > &objectRef) const
	Returns whether two object references are holds the same internal object.
bool	operator!= (const ObjectRef< T > &objectRef) const
	Returns whether two object references are not equal.
bool	operator< (const ObjectRef< T > &objectRef) const
	Returns whether the left object is less than the right one.
	operator bool () const
	Returns whether this object reference holds an internal object.

Private Types
typedef SmartObjectRef< T, Device >::ReleaseCallback	ReleaseCallback
	Redefinition of the release callback function defined in ObjectRef.

Additional Inherited Members
Public Types inherited from Ocean::SmartObjectRef< T, Device >
typedef ObjectRef< Device >::ReleaseCallback	ReleaseCallback
	Redefinition of the release callback function defined in ObjectRef.
Public Types inherited from Ocean::ObjectRef< T >
typedef Callback< void, const T * >	ReleaseCallback
	Definition of a release callback function.
Static Protected Member Functions inherited from Ocean::ObjectRef< T >
static void	destroyObject (T *object)
	Destroys the object located in the ObjectHolder object.
Protected Attributes inherited from Ocean::SmartObjectRef< T, Device >
T *	objectPointer_
	Pointer to the internal object.
Protected Attributes inherited from Ocean::ObjectRef< T >
ObjectHolder *	objectHolder_ = nullptr
	Pointer to the object holder.

Detailed Description

template<typename T>
class Ocean::Devices::SmartDeviceRef< T >

This class implements a smart device reference.

Template Parameters

T	Type of the derived object that has to be encapsulated by the smart reference object

Member Typedef Documentation

ReleaseCallback

template<typename T >

typedef SmartObjectRef<T,Device>::ReleaseCallback Ocean::Devices::SmartDeviceRef< T >::ReleaseCallback

private

Redefinition of the release callback function defined in ObjectRef.

Constructor & Destructor Documentation

SmartDeviceRef() [1/4]

template<typename T >

Ocean::Devices::SmartDeviceRef< T >::SmartDeviceRef

(

)

Creates an empty smart device reference.

SmartDeviceRef() [2/4]

template<typename T >

Ocean::Devices::SmartDeviceRef< T >::SmartDeviceRef

(

const DeviceRef &

deviceRef

)

Creates a new smart device reference by a given device reference.

Parameters

deviceRef

Device reference to copy

SmartDeviceRef() [3/4]

template<typename T >

Ocean::Devices::SmartDeviceRef< T >::SmartDeviceRef ( Device *  object )

explicit

Creates a new SmartDeviceRef by a given object.

This given object will be released by the smart device reference itself.

Parameters

object

Internal object

SmartDeviceRef() [4/4]

template<typename T >

template<typename T2 >

Ocean::Devices::SmartDeviceRef< T >::SmartDeviceRef

(

const SmartDeviceRef< T2 > &

reference

)

Copies a smart device reference.

Parameters

reference

Reference to copy

Member Function Documentation

operator=()

template<typename T >

SmartDeviceRef< T > & Ocean::Devices::SmartDeviceRef< T >::operator=

(

const DeviceRef &

deviceRef

)

Assigns a smart device reference.

Parameters

deviceRef

reference Reference to assign

Returns

Reference to this object

---

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

• DeviceRef.h