ObjPtr< T_Obj > Class Template Reference

Pointer to objects managed by ObjContainer. More...

#include <ObjContainer.h>

Collaboration diagram for ObjPtr< T_Obj >:

Public Member Functions
	ObjPtr ()=default
	ObjPtr (ObjPtr &&obj_ptr)=default
	ObjPtr (const ObjPtr &obj_ptr)
	ObjPtr (ObjContainer< T_Obj > &container, const T_Obj &obj)
	Store an external object in the container. More...
	ObjPtr (ObjContainer< T_Obj > &container, std::unique_ptr< T_Obj > obj)
	Pass a unique_ptr to the container The Unique_ptr becomes an Owned object i.e has count 1. More...
	ObjPtr (ObjContainer< T_Obj > &container, ObjRef ref=ObjRef())
	Share the referred object managed by the given container. More...
	~ObjPtr () noexcept(false)
	operator bool () const
	Test whether this pointer points to a valid object. More...
ObjPtr &	operator= (const ObjPtr &obj)
ObjPtr &	operator= (ObjPtr &&obj)
ObjPtr &	operator= (ObjRef ref)
bool	operator== (const ObjPtr &obj) const
	Test whether two pointer point to the same object. More...
bool	operator!= (const ObjPtr &obj) const
	Test whether two pointer point to different objects. More...
T_Obj &	operator* ()
T_Obj *	operator-> ()
T_Obj *	get ()
	Get a pointer to a valid manged object. More...
const T_Obj *	get () const
	Get a const pointer to a valid manged object. More...
T_Obj *	release ()
	Release the object this pointer points to from the container. More...
std::unique_ptr< T_Obj >	to_unique ()
	Release the object this pointer points to from the container. More...
ObjRef	index () const
	Get a light-weight reference to the object pointed to by this pointer The returned light-weight reference does not provide any lifetime guarantees of the object. More...
bool	isOwned () const
	Return true if the object is managed and owned by the container. More...
bool	isShared () const
	Return true if the object is managed by the container and if there are more than one instances of ObjPtr which point to this object. More...
bool	isExtern () const
	Return true if the object is an external object i.e. More...

Protected Member Functions
void	shareAndSet (ObjRef ref)
	Helper method to increase the share count of the referenced object and point to that object. More...

Private Attributes
ObjContainer< T_Obj > *	m_container = nullptr
	pointer to the conainer More...
ObjRef	m_ref {}
	a valid reference to an object stored in the container or an invalid reference. More...

Detailed Description

template<class T_Obj>
class ObjPtr< T_Obj >

Pointer to objects managed by ObjContainer.

Definition at line 33 of file ObjContainer.h.

Constructor & Destructor Documentation

ObjPtr() [1/6]

template<class T_Obj >

ObjPtr< T_Obj >::ObjPtr ( )

default

ObjPtr() [2/6]

template<class T_Obj >

ObjPtr< T_Obj >::ObjPtr ( ObjPtr< T_Obj > &&  obj_ptr )

default

ObjPtr() [3/6]

template<class T_Obj >

ObjPtr< T_Obj >::ObjPtr ( const ObjPtr< T_Obj > &  obj_ptr )

inline

Definition at line 477 of file ObjContainer.h.

      : m_container(obj_ptr.m_container)
   {
      shareAndSet(obj_ptr.index());
   }

ObjPtr() [4/6]

template<class T_Obj >

ObjPtr< T_Obj >::ObjPtr ( ObjContainer< T_Obj > &  container, const T_Obj &  obj  )

inline

Store an external object in the container.

Parameters

container	the container to store the given object
obj	the external object to be stored in the container. The container will not claim ownership.

Definition at line 488 of file ObjContainer.h.

     : m_container(&container)
     , m_ref(m_container->registerObj(obj))
   {}

ObjPtr() [5/6]

template<class T_Obj >

ObjPtr< T_Obj >::ObjPtr ( ObjContainer< T_Obj > &  container, std::unique_ptr< T_Obj >  obj  )

inline

Pass a unique_ptr to the container The Unique_ptr becomes an Owned object i.e has count 1.

Parameters

container	the container to store the given object
obj	the object to be managed.

Definition at line 501 of file ObjContainer.h.

     : ObjPtr(container, container.registerObj(obj.release()))
   {}

ObjPtr() [6/6]

template<class T_Obj >

ObjPtr< T_Obj >::ObjPtr ( ObjContainer< T_Obj > &  container, ObjRef  ref = ObjRef()  )

inline

Share the referred object managed by the given container.

Parameters

container	the container which manages the referenced object.
ref	a reference to an object in the container (or an invalid reference) to create on invalid ObjPtr.

Definition at line 509 of file ObjContainer.h.

     : m_container(&container)
     , m_ref(ref ? container.share(ref) : ref)
   {}

~ObjPtr()

template<class T_Obj >

ObjPtr< T_Obj >::~ObjPtr ( )

inlinenoexcept

Definition at line 514 of file ObjContainer.h.

                            {
     if (m_ref) {
       m_container->drop(m_ref);
     }
   }

Member Function Documentation

get() [1/2]

template<class T_Obj >

T_Obj* ObjPtr< T_Obj >::get ( )

inline

Get a pointer to a valid manged object.

Exceptions

will	throw an exception if this pointer does not point to a valid object.

Definition at line 588 of file ObjContainer.h.

                {
      if (!m_ref) return nullptr;
      else        return m_container->get(m_ref);
   }

get() [2/2]

template<class T_Obj >

const T_Obj* ObjPtr< T_Obj >::get ( ) const

inline

Get a const pointer to a valid manged object.

Exceptions

will	throw an exception if this pointer does not point to a valid object.

Definition at line 598 of file ObjContainer.h.

                            {
      if (!m_ref) return nullptr;
      else        return std::as_const(*m_container).get(m_ref);
   }

index()

template<class T_Obj >

ObjRef ObjPtr< T_Obj >::index ( ) const

inline

Get a light-weight reference to the object pointed to by this pointer The returned light-weight reference does not provide any lifetime guarantees of the object.

Definition at line 629 of file ObjContainer.h.

{ return m_ref; }

isExtern()

template<class T_Obj >

bool ObjPtr< T_Obj >::isExtern ( ) const

inline

Return true if the object is an external object i.e.

if the container does not have ownership over this object.

Definition at line 660 of file ObjContainer.h.

                         {
      return m_container->isExtern(m_ref);
   }

isOwned()

template<class T_Obj >

bool ObjPtr< T_Obj >::isOwned ( ) const

inline

Return true if the object is managed and owned by the container.

Definition at line 648 of file ObjContainer.h.

                        {
      return m_container->isOwned(m_ref);
   }

isShared()

template<class T_Obj >

bool ObjPtr< T_Obj >::isShared ( ) const

inline

Return true if the object is managed by the container and if there are more than one instances of ObjPtr which point to this object.

Definition at line 654 of file ObjContainer.h.

                         {
      return m_container->isShared(m_ref);
   }

operator bool()

template<class T_Obj >

ObjPtr< T_Obj >::operator bool ( ) const

inline

Test whether this pointer points to a valid object.

Definition at line 522 of file ObjContainer.h.

{ return m_container && m_container->isValid(m_ref); }

operator!=()

template<class T_Obj >

bool ObjPtr< T_Obj >::operator!= ( const ObjPtr< T_Obj > &  obj ) const

inline

Test whether two pointer point to different objects.

Definition at line 573 of file ObjContainer.h.

                                             {
      return obj.m_ref != m_ref;
   }

operator*()

template<class T_Obj >

T_Obj& ObjPtr< T_Obj >::operator* ( )

inline

Definition at line 577 of file ObjContainer.h.

                      {
      return *m_container->get(m_ref);
   }

operator->()

template<class T_Obj >

T_Obj* ObjPtr< T_Obj >::operator-> ( )

inline

Definition at line 581 of file ObjContainer.h.

                       {
      return get();
   }

operator=() [1/3]

template<class T_Obj >

ObjPtr& ObjPtr< T_Obj >::operator= ( const ObjPtr< T_Obj > &  obj )

inline

Definition at line 524 of file ObjContainer.h.

                                        {
      if (obj.m_ref != m_ref) {
         if (*this) {
            m_container->drop(m_ref);
         }
         if (obj.m_container) {
            assert( !m_container || m_container == obj.m_container);
            m_container = obj.m_container;
         }
         shareAndSet(obj.index());
      }
      return *this;
   }

operator=() [2/3]

template<class T_Obj >

ObjPtr& ObjPtr< T_Obj >::operator= ( ObjPtr< T_Obj > &&  obj )

inline

Definition at line 538 of file ObjContainer.h.

                                   {
      if (&obj != this) {
         if (*this) {
            m_container->drop(m_ref);
         }
         m_ref = std::move(obj.m_ref);
         if (obj.m_container) {
            assert( !m_container || m_container == obj.m_container);
            m_container = obj.m_container;
         }
      }
      return *this;
   }

operator=() [3/3]

template<class T_Obj >

ObjPtr& ObjPtr< T_Obj >::operator= ( ObjRef  ref )

inline

Definition at line 552 of file ObjContainer.h.

                                  {
      if (ref != m_ref) {
         if (*this) {
            m_container->drop(m_ref);
         }
         if (!m_container) {
            ObjContainerBase::throwNoContainer();
         }
         shareAndSet(ref);
      }
      return *this;
   }

operator==()

template<class T_Obj >

bool ObjPtr< T_Obj >::operator== ( const ObjPtr< T_Obj > &  obj ) const

inline

Test whether two pointer point to the same object.

Definition at line 567 of file ObjContainer.h.

                                             {
      return obj.m_ref == m_ref;
   }

release()

template<class T_Obj >

T_Obj* ObjPtr< T_Obj >::release ( )

inline

Release the object this pointer points to from the container.

Returns

a pointer to the object This will remove the ownership over this object from the container. If there are still other ObjPtr instances alive which point to this object, then the object will remain in the container. This it is up to the user to ensure that the object stays alive at least as long as the container.

Definition at line 610 of file ObjContainer.h.

                    {
      if (!m_ref) return nullptr;
      else        return m_container->release(m_ref);
   }

shareAndSet()

template<class T_Obj >

void ObjPtr< T_Obj >::shareAndSet ( ObjRef  ref )

inlineprotected

Helper method to increase the share count of the referenced object and point to that object.

Definition at line 635 of file ObjContainer.h.

                                 {
      if (ref) {
         assert(m_container);
         m_ref=m_container->share(ref);
      }
      else {
         m_ref=ref;
      }
   }

to_unique()

template<class T_Obj >

std::unique_ptr<T_Obj> ObjPtr< T_Obj >::to_unique ( )

inline

Release the object this pointer points to from the container.

Returns

a unique_ptr to the object This will remove the ownership over this object from the container. If there are still other ObjPtr instances alive which point to this object, then the object will remain in the container. Then it is up to the user to ensure that the unique_ptr stays alive at least as long as the container.

Definition at line 622 of file ObjContainer.h.

                                     {
      return std::unique_ptr<T_Obj>(release());
    }

Member Data Documentation

m_container

template<class T_Obj >

ObjContainer<T_Obj>* ObjPtr< T_Obj >::m_container = nullptr

private

pointer to the conainer

Definition at line 666 of file ObjContainer.h.

m_ref

template<class T_Obj >

ObjRef ObjPtr< T_Obj >::m_ref {}

private

a valid reference to an object stored in the container or an invalid reference.

Definition at line 667 of file ObjContainer.h.

---

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

• ObjContainer.h