HF::Common::Pointer< T > Class Template Reference

Simple raw pointer wrapper. More...

#include <common.h>

Collaboration diagram for HF::Common::Pointer< T >:

Public Member Functions
	Pointer (T *_pointer=nullptr, bool _owner=false)
	Constructor. More...
	Pointer (T &_pointer)
	Constructor. More...
	Pointer (Pointer< T > &&other)
	Move constructor. More...
	Pointer (Pointer< T > &other)
	Copy constructor. More...
Pointer< T > &	operator= (Pointer< T > &&other)
	Assignment move operator. More...

Detailed Description

template<typename T>
class HF::Common::Pointer< T >

Simple raw pointer wrapper.

Definition at line 1178 of file inc/hanfun/common.h.

Constructor & Destructor Documentation

Pointer() [1/4]

template<typename T>

HF::Common::Pointer< T >::Pointer ( T *  _pointer = nullptr, bool  _owner = false  )

inline

Constructor.

Parameters

[in]	_pointer	pointer to wrap.
[in]	_owner	boolean indicating if the underling pointer should be deleted when this object is deleted.

Definition at line 1193 of file inc/hanfun/common.h.

                                                            :
            pointer(_pointer), owner(_owner)
         {}

Pointer() [2/4]

template<typename T>

HF::Common::Pointer< T >::Pointer ( T &  _pointer )

inline

Constructor.

Parameters

[in]

_pointer

pointer to wrap.

Definition at line 1202 of file inc/hanfun/common.h.

                             :
            pointer(&_pointer), owner(false)
         {}

Pointer() [3/4]

template<typename T>

HF::Common::Pointer< T >::Pointer ( Pointer< T > &&  other )

inline

Move constructor.

Parameters

[in]

other

original object.

Definition at line 1211 of file inc/hanfun/common.h.

                                    : pointer(nullptr), owner(false)
         {
            std::swap(this->pointer, other.pointer);
            std::swap(this->owner, other.owner);
         }

Pointer() [4/4]

template<typename T>

HF::Common::Pointer< T >::Pointer ( Pointer< T > &  other )

inline

Copy constructor.

Parameters

[in]

other

original object.

Definition at line 1222 of file inc/hanfun/common.h.

                                   : pointer(other.pointer), owner(other.owner)
         {
            other.owner = false;
         }

Member Function Documentation

operator=()

template<typename T>

Pointer<T>& HF::Common::Pointer< T >::operator= ( Pointer< T > &&  other )

inline

Assignment move operator.

Parameters

[in]

other

object to move from.

Returns

reference to this object.

Definition at line 1282 of file inc/hanfun/common.h.

         {
            if (this->owner)
            {
               delete this->pointer;
            }

            this->pointer = other.pointer;
            this->owner   = other.owner;

            other.owner   = false;

            return *this;
         }

---

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

• inc/hanfun/common.h