Handler class for automatic pointer. More...

#include <JSelector.hh>

Inheritance diagram for JTOOLS::JAutoElement< JBase_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
	JAutoElement ()
	Default constructor.

template<class JDerived_t >
	JAutoElement (JType< JDerived_t > type)
	Constructor.

template<class JDerived_t >
	JAutoElement (JDerived_t *p)
	Constructor.

template<class JDerived_t >
void	set ()
	Set the automatic pointer to the given data type.

template<class JDerived_t >
void	set (JType< JDerived_t > type)
	Set the automatic pointer to the given data type.

template<class JDerived_t >
void	set (JDerived_t *p)
	Set the automatic pointer to the given data type.

template<class JDerived_t >
JAutoElement &	operator= (JType< JDerived_t > type)
	Assign given data type to the automatic pointer.

template<class JDerived_t >
JAutoElement &	operator= (JDerived_t *p)
	Assign given data type to the automatic pointer.

const JSharedPointer &	getSharedPointer () const
	Get shared pointer.

JSharedPointer &	getSharedPointer ()
	Get shared pointer.

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

virtual void	reset () override
	Reset pointer.

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

void	reset (JClass_t *p)
	Reset pointer.

template<class T >
void	set (const JPointer< T > &pointer)
	Set 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	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.

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

Private Types
typedef JAbstractAutoPointer< JBase_t >	JAbstractAutoPointer_t

typedef JSharedPointer< JAbstractAutoPointer_t >	JSharedPointer_t

typedef JAutoElement< JBase_t >	JAutoElement_t

Friends
std::istream &	operator>> (std::istream &in, JAutoElement_t &element)
	Stream input.

std::ostream &	operator<< (std::ostream &out, const JAutoElement_t &element)
	Stream output.

Detailed Description

template<class JBase_t>
class JTOOLS::JAutoElement< JBase_t >

Handler class for automatic pointer.

Definition at line 128 of file JTools/JSelector.hh.

Member Typedef Documentation

◆ JAbstractAutoPointer_t

template<class JBase_t >

JAbstractAutoPointer<JBase_t> JTOOLS::JAutoElement< JBase_t >::JAbstractAutoPointer_t

private

Definition at line 132 of file JTools/JSelector.hh.

◆ JSharedPointer_t

template<class JBase_t >

JSharedPointer<JAbstractAutoPointer_t> JTOOLS::JAutoElement< JBase_t >::JSharedPointer_t

private

Definition at line 133 of file JTools/JSelector.hh.

◆ JAutoElement_t

template<class JBase_t >

JAutoElement<JBase_t> JTOOLS::JAutoElement< JBase_t >::JAutoElement_t

private

Definition at line 134 of file JTools/JSelector.hh.

◆ pointer_type

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

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

inherited

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

inherited

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

◆ JAutoElement() [1/3]

template<class JBase_t >

JTOOLS::JAutoElement< JBase_t >::JAutoElement ( )

inline

Default constructor.

Definition at line 140 of file JTools/JSelector.hh.

                   :
      JSharedPointer_t()
    {}

◆ JAutoElement() [2/3]

template<class JBase_t >

template<class JDerived_t >

JTOOLS::JAutoElement< JBase_t >::JAutoElement ( JType< JDerived_t > type )

inline

Constructor.

Parameters

type data type

Definition at line 151 of file JTools/JSelector.hh.

                                         :
      JSharedPointer_t()
    {
      this->set(type);
    }

◆ JAutoElement() [3/3]

template<class JBase_t >

template<class JDerived_t >

JTOOLS::JAutoElement< JBase_t >::JAutoElement ( JDerived_t * p )

inline

Constructor.

This class owns the pointer.

Parameters

p	pointer to object

Definition at line 165 of file JTools/JSelector.hh.

                                :
      JSharedPointer_t()
    {
      this->set(p);
    }

Member Function Documentation

◆ set() [1/6]

template<class JBase_t >

template<class JDerived_t >

void JTOOLS::JAutoElement< JBase_t >::set ( )

inline

Set the automatic pointer to the given data type.

Definition at line 176 of file JTools/JSelector.hh.

    {
      this->set(JType<JDerived_t>());
    }

◆ set() [2/6]

template<class JBase_t >

template<class JDerived_t >

void JTOOLS::JAutoElement< JBase_t >::set ( JType< JDerived_t > type )

inline

Set the automatic pointer to the given data type.

Parameters

type data type

Definition at line 188 of file JTools/JSelector.hh.

    {
      this->reset(new JAutoPointer<JDerived_t, JBase_t>());
    }

◆ set() [3/6]

template<class JBase_t >

template<class JDerived_t >

void JTOOLS::JAutoElement< JBase_t >::set ( JDerived_t * p )

inline

Set the automatic pointer to the given data type.

Parameters

p	pointer to object

Definition at line 200 of file JTools/JSelector.hh.

    {
      this->reset(new JAutoPointer<JDerived_t, JBase_t>(p));
    }

◆ operator=() [1/2]

template<class JBase_t >

template<class JDerived_t >

JAutoElement & JTOOLS::JAutoElement< JBase_t >::operator= ( JType< JDerived_t > type )

inline

Assign given data type to the automatic pointer.

Parameters

type data type

Returns: this JAutoElement

Definition at line 213 of file JTools/JSelector.hh.

    {
      set(type);
 
      return *this;
    }

◆ operator=() [2/2]

template<class JBase_t >

template<class JDerived_t >

JAutoElement & JTOOLS::JAutoElement< JBase_t >::operator= ( JDerived_t * p )

inline

Assign given data type to the automatic pointer.

Parameters

p	pointer to object

Returns: this JAutoElement

Definition at line 228 of file JTools/JSelector.hh.

    {
      set(p);
 
      return *this;
    }

◆ getSharedPointer() [1/2]

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

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

inlineinherited

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 ( )

inlineinherited

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 )

inlineinherited

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);
        }
      }
    }

◆ reset() [1/3]

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

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

inlineoverridevirtualinherited

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();
    }

◆ 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);
        }
      }
    }

◆ set() [4/6]

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 )

inlineprotectedinherited

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() [5/6]

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

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

inlineoverrideprotectedvirtualinherited

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();
    }

◆ set() [6/6]

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());
    }

◆ 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);
    }

◆ 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;
    }

◆ 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();
    }

Friends And Related Symbol Documentation

◆ operator>>

template<class JBase_t >

std::istream & operator>>	(	std::istream &	in,
		JAutoElement_t &	element )

friend

Stream input.

Parameters

in	input stream
element	element

Returns: input stream

Definition at line 243 of file JTools/JSelector.hh.

    {
      if (element.is_valid())
        return element.get()->read(in);
      else
        return in;
    }  

◆ operator<<

template<class JBase_t >

std::ostream & operator<<	(	std::ostream &	out,
		const JAutoElement_t &	element )

friend

Stream output.

Parameters

out	output stream
element	element

Returns: output stream

Definition at line 259 of file JTools/JSelector.hh.

    {
      if (element.is_valid())
        return element.get()->write(out);
      else
        return out;
    }  

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:

JTools/JSelector.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Friends

Detailed Description

Member Typedef Documentation

◆ JAbstractAutoPointer_t

◆ JSharedPointer_t

◆ JAutoElement_t

◆ pointer_type

◆ storage_type

◆ memory_type

Constructor & Destructor Documentation

◆ JAutoElement() [1/3]

◆ JAutoElement() [2/3]

◆ JAutoElement() [3/3]

Member Function Documentation

◆ set() [1/6]

◆ set() [2/6]

◆ set() [3/6]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ getSharedPointer() [1/2]

◆ getSharedPointer() [2/2]

◆ setSharedPointer()

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

◆ set() [4/6]

◆ set() [5/6]

◆ set() [6/6]

◆ initialise()

◆ attach()

◆ detach()

◆ getCount()

◆ recreate()

◆ create() [1/2]

◆ create() [2/2]

◆ release() [1/2]

◆ release() [2/2]

◆ get()

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ equals()

◆ is_valid()

◆ operator->()

◆ operator JClass_t *()

Friends And Related Symbol Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ counter

◆ __p