The template JSharedPointer class can be used to share a pointer to an object. More...

#include <JSharedPointer.hh>

Inheritance diagram for JLANG::JSharedPointer< JClass_t, JMemory_t >:

Public Types
typedef JPointer< JClass_t >	pointer_type

typedef JStorage< JClass_t, JMemory_t >	storage_type

typedef JNew< JClass_t >	memory_type

Public Member Functions
	JSharedPointer ()
	Default constructor.

	JSharedPointer (const JSharedPointer &object)
	Copy constructor.

template<class JDerived_t >
	JSharedPointer (JDerived_t *p)
	Assignment constructor.

	~JSharedPointer ()
	Destructor.

const JSharedPointer &	getSharedPointer () const
	Get shared pointer.

JSharedPointer &	getSharedPointer ()
	Get shared pointer.

void	setSharedPointer (const JSharedPointer &object)
	Set shared pointer.

JSharedPointer &	operator= (const JSharedPointer &object)
	Assignment operator.

template<class JDerived_t >
JSharedPointer &	operator= (JDerived_t *p)
	Assignment operator.

virtual void	reset () override
	Reset pointer.

void	initialise ()
	Initialise counter.

void	attach (const JSharedCounter &object)
	Attach this counter to given shared counter object.

bool	detach ()
	Detach.

const int	getCount ()
	Get count.

void	reset (const JPointer< T > &pointer)
	Reset pointer.

void	reset (JClass_t *p)
	Reset pointer.

void	recreate ()
	Recreate object in memory.

void	create ()
	Create object in memory.

void	create (const unsigned int size)
	Create array of objects in memory.

virtual JClass_t *	get () const override
	Get pointer.

template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer.

JClass_t *const &	getReference () const
	Get rereference to internal pointer.

JClass_t *&	getReference ()
	Get rereference to internal pointer.

virtual bool	equals (const JAbstractPointer &object) const
	Equals.

bool	is_valid () const
	Check validity of pointer.

JClass_t *	operator-> () const
	Smart pointer operator.

	operator JClass_t * () const
	Type conversion operator.

Static Public Member Functions
static void	release (JClass_t *p)
	Release memory.

Protected Member Functions
void	set (const JSharedPointer &object)
	Set pointer.

virtual void	set (JClass_t *p) override
	Set pointer.

void	release ()
	Release memory.

Protected Attributes
int *	counter

JClass_t *	__p
	pointer to object

Detailed Description

template<class JClass_t, template< class > class JMemory_t = JNew>
class JLANG::JSharedPointer< JClass_t, JMemory_t >

The template JSharedPointer class can be used to share a pointer to an object.

The object pointed to is deleted when the shared counter is zero, i.e. when no-one shares the object. It is possible to create a container with shared pointers. The first template argument refers to the data type pointed to and the second to the memory management policy.

Definition at line 28 of file JSharedPointer.hh.

Member Typedef Documentation

◆ pointer_type

template<class JClass_t , template< class > class JMemory_t = JNew>

JPointer<JClass_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::pointer_type

Definition at line 34 of file JSharedPointer.hh.

◆ storage_type

template<class JClass_t , template< class > class JMemory_t = JNew>

JStorage<JClass_t, JMemory_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::storage_type

Definition at line 35 of file JSharedPointer.hh.

◆ memory_type

JNew<JClass_t> JLANG::JStorage< JClass_t, JNew >::memory_type

inherited

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

◆ JSharedPointer() [1/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

JLANG::JSharedPointer< JClass_t, JMemory_t >::JSharedPointer ( )

inline

Default constructor.

Definition at line 43 of file JSharedPointer.hh.

44 {}

◆ JSharedPointer() [2/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

JLANG::JSharedPointer< JClass_t, JMemory_t >::JSharedPointer ( const JSharedPointer< JClass_t, JMemory_t > & object )

inline

Copy constructor.

The reference counter of the shared object is incremented by one.

Parameters

object shared pointer

Definition at line 53 of file JSharedPointer.hh.

    {
      if (object.is_valid()) {
        this->set(object);
      }
    }

◆ JSharedPointer() [3/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

template<class JDerived_t >

JLANG::JSharedPointer< JClass_t, JMemory_t >::JSharedPointer ( JDerived_t * p )

inline

Assignment constructor.

If the pointer is valid, the reference counter of the shared object pointed to is initialised to one.

Parameters

p	pointer to derived class object

Definition at line 69 of file JSharedPointer.hh.

    {
      if (p != NULL) {
        this->set(p);
      }
    }

◆ ~JSharedPointer()

template<class JClass_t , template< class > class JMemory_t = JNew>

JLANG::JSharedPointer< JClass_t, JMemory_t >::~JSharedPointer ( )

inline

Destructor.

The reference counter is decremented by one and the object pointed to is deleted when the reference counter is zero.

Definition at line 82 of file JSharedPointer.hh.

    {
      if (this->detach()) {
        storage_type::reset();
      }
    }

Member Function Documentation

◆ getSharedPointer() [1/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

const JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( ) const

inline

Get shared pointer.

Returns: this shared pointer

Definition at line 95 of file JSharedPointer.hh.

    {
      return static_cast<const JSharedPointer&>(*this);
    }

◆ getSharedPointer() [2/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( )

inline

Get shared pointer.

Returns: this shared pointer

Definition at line 106 of file JSharedPointer.hh.

    {
      return static_cast<JSharedPointer&>(*this);
    }

◆ setSharedPointer()

template<class JClass_t , template< class > class JMemory_t = JNew>

void JLANG::JSharedPointer< JClass_t, JMemory_t >::setSharedPointer ( const JSharedPointer< JClass_t, JMemory_t > & object )

inline

Set shared pointer.

Parameters

object shared pointer

Definition at line 117 of file JSharedPointer.hh.

    {
      if (this->get() != object.get()) {
 
        this->reset();
 
        if (object.is_valid()) {
          this->set(object);
        }
      }
    }

◆ operator=() [1/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::operator= ( const JSharedPointer< JClass_t, JMemory_t > & object )

inline

Assignment operator.

The reference counter is decremented by one and the object pointed to previously is deleted when its reference counter is zero. The reference counter of the shared object is incremented by one.

Parameters

object shared pointer

Returns: this shared pointer

Definition at line 139 of file JSharedPointer.hh.

    {
      this->setSharedPointer(object);
 
      return *this;
    }

◆ operator=() [2/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

template<class JDerived_t >

JSharedPointer & JLANG::JSharedPointer< JClass_t, JMemory_t >::operator= ( JDerived_t * p )

inline

Assignment operator.

The reference counter is decremented by one and the object pointed to previously is deleted when its reference counter is zero. If the pointer is valid, the reference counter of the shared object pointed to is initialised to one.

Parameters

p	pointer to derived class object

Returns: this shared pointer

Definition at line 158 of file JSharedPointer.hh.

    {
      this->reset(p);
 
      return *this;
    }

◆ reset() [1/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::reset ( )

inlineoverridevirtual

Reset pointer.

The reference counter is decremented by one and the object pointed to previously is deleted when its reference counter is zero.

Reimplemented from JLANG::JStorage< JClass_t, JNew >.

Definition at line 171 of file JSharedPointer.hh.

    {
      if (this->detach()) {
        storage_type::reset();
      }
 
      pointer_type::reset();
    }

◆ set() [1/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

void JLANG::JSharedPointer< JClass_t, JMemory_t >::set ( const JSharedPointer< JClass_t, JMemory_t > & object )

inlineprotected

Set pointer.

The reference counter of the shared object pointed to is incremented by one.

Parameters

object shared pointer

Definition at line 188 of file JSharedPointer.hh.

    {
      pointer_type::set(object.get());
 
      this->attach(object);
    }

◆ set() [2/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::set ( JClass_t * p )

inlineoverrideprotectedvirtual

Set pointer.

The reference counter of the shared object pointed to is initialised to one.

Parameters

p	pointer to derived class object

Reimplemented from JLANG::JPointer< JClass_t >.

Definition at line 202 of file JSharedPointer.hh.

    {
      pointer_type::set(p);
 
      this->initialise();
    }

◆ initialise()

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

    {
      detach();
 
      counter = new int(1);
    }

◆ attach()

void JLANG::JSharedCounter::attach ( const JSharedCounter & object )

inlineinherited

Attach this counter to given shared counter object.

Parameters

object shared counter

Definition at line 46 of file JSharedCounter.hh.

    {
      detach();
 
      counter = object.counter;
 
      if (counter != NULL) {
        ++(*counter);
      }
    }

◆ detach()

bool JLANG::JSharedCounter::detach ( )

inlineinherited

Detach.

Returns: true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

    {
      if (counter != NULL) {
 
        if (--(*counter) == 0) {
 
          delete counter;
 
          counter = NULL;
 
          return true;
        }
 
        counter = NULL;
      }
 
      return false;
    }

◆ getCount()

const int JLANG::JSharedCounter::getCount ( )

inlineinherited

Get count.

Returns: count

Definition at line 88 of file JSharedCounter.hh.

    {
      return (counter != NULL ? *counter : 0);
    }

◆ reset() [2/3]

void JLANG::JPointer< JClass_t >::reset ( const JPointer< T > & pointer )

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 35 of file JPointer.hh.

    {
      this->reset(pointer.get());
    }

◆ reset() [3/3]

template<class JClass_t >

void JLANG::JAbstractPointer< JClass_t >::reset ( JClass_t * p )

inlineinherited

Reset pointer.

Parameters

p	pointer to object

Definition at line 94 of file JAbstractPointer.hh.

    {
      if (this->get() != p) {
 
        this->reset();
 
        if (p != NULL) {
          this->set(p);
        }
      }
    }

◆ recreate()

void JLANG::JStorage< JClass_t, JNew >::recreate ( )

inlineinherited

Recreate object in memory.

A new object is created if no memory is allocated yet, else the previously created object is maintained.

Definition at line 57 of file JStorage.hh.

    {
      if (!this->is_valid()) {
        this->set(memory_type::create());
      }
    }

◆ create() [1/2]

void JLANG::JStorage< JClass_t, JNew >::create ( )

inlineinherited

Create object in memory.

The memory allocated by a previously created object will be released.

Definition at line 69 of file JStorage.hh.

    {
      this->reset(memory_type::create());
    }

◆ create() [2/2]

void JLANG::JStorage< JClass_t, JNew >::create ( const unsigned int size )

inlineinherited

Create array of objects in memory.

The memory allocated by previously created objects will be released.

Parameters

size	number of elements

Definition at line 81 of file JStorage.hh.

    {
      this->reset(memory_type::create(size));
    }

◆ release() [1/2]

void JLANG::JStorage< JClass_t, JNew >::release ( )

inlineprotectedinherited

Release memory.

Definition at line 91 of file JStorage.hh.

    { 
      memory_type::release(this->get());
    }

◆ release() [2/2]

template<class JClass_t >

static void JLANG::JNew< JClass_t >::release ( JClass_t * p )

inlinestaticinherited

Release memory.

Parameters

p	pointer to data

Definition at line 41 of file JMemory.hh.

    {
      delete p;
    }

◆ get()

template<class JClass_t >

virtual JClass_t * JLANG::JPointer< JClass_t >::get ( ) const

inlineoverridevirtualinherited

Get pointer.

Returns: pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JHead_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JTypeList< JDAQEvent, JNullType > >, JLANG::JMultiPointer< JTypeList< JHead_t, JTail_t > >, and JLANG::JMultiPointer< T >.

Definition at line 64 of file JPointer.hh.

    {
      return this->__p;
    }

◆ set() [3/3]

template<class JClass_t >

template<class T >

void JLANG::JPointer< JClass_t >::set ( const JPointer< T > & pointer )

inlineinherited

Set pointer.

Parameters

pointer pointer to object

Definition at line 96 of file JPointer.hh.

    {
      this->set(pointer.get());
    }

◆ getReference() [1/2]

template<class JClass_t >

JClass_t *const & JLANG::JPointer< JClass_t >::getReference ( ) const

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 119 of file JPointer.hh.

    {
      return __p;
    }

◆ getReference() [2/2]

template<class JClass_t >

JClass_t *& JLANG::JPointer< JClass_t >::getReference ( )

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 130 of file JPointer.hh.

    {
      return __p;
    }

◆ equals()

template<class JClass_t >

virtual bool JLANG::JAbstractPointer< JClass_t >::equals ( const JAbstractPointer< JClass_t > & object ) const

inlinevirtualinherited

Equals.

The equality is evaluated by comparison of the internal pointers.

Parameters

object abstract pointer

Returns: true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

    {
      return this->get() == object.get();
    }

◆ is_valid()

template<class JClass_t >

bool JLANG::JAbstractPointer< JClass_t >::is_valid ( ) const

inlineinherited

Check validity of pointer.

Returns: true if pointer not null; else false

Definition at line 83 of file JAbstractPointer.hh.

    { 
      return this->get() != NULL; 
    }

◆ operator->()

template<class JClass_t >

JClass_t * JLANG::JAbstractPointer< JClass_t >::operator-> ( ) const

inlineinherited

Smart pointer operator.

Returns: pointer to object

Definition at line 112 of file JAbstractPointer.hh.

    { 
      if (!is_valid())
        THROW(JNullPointerException, "JAbstractPointer::operator->()");
      else
        return this->get();
    }

◆ operator JClass_t *()

template<class JClass_t >

JLANG::JAbstractPointer< JClass_t >::operator JClass_t * ( ) const

inlineinherited

Type conversion operator.

Returns: pointer to object

Definition at line 126 of file JAbstractPointer.hh.

    {
      return this->get();
    }

Member Data Documentation

◆ counter

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 94 of file JSharedCounter.hh.

◆ __p

template<class JClass_t >

JClass_t* JLANG::JPointer< JClass_t >::__p

protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.

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

JSharedPointer.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ pointer_type

◆ storage_type

◆ memory_type

Constructor & Destructor Documentation

◆ JSharedPointer() [1/3]

◆ JSharedPointer() [2/3]

◆ JSharedPointer() [3/3]

◆ ~JSharedPointer()

Member Function Documentation

◆ getSharedPointer() [1/2]

◆ getSharedPointer() [2/2]

◆ setSharedPointer()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ reset() [1/3]

◆ set() [1/3]

◆ set() [2/3]

◆ initialise()

◆ attach()

◆ detach()

◆ getCount()

◆ reset() [2/3]

◆ reset() [3/3]

◆ recreate()

◆ create() [1/2]

◆ create() [2/2]

◆ release() [1/2]

◆ release() [2/2]

◆ get()

◆ set() [3/3]

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ equals()

◆ is_valid()

◆ operator->()

◆ operator JClass_t *()

Member Data Documentation

◆ counter

◆ __p