JLANG::JStorage< JClass_t, JMemory_t > Class Template Reference

Template storage class. More...

#include <JStorage.hh>

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

Public Types
typedef JPointer< JClass_t >	pointer_type
typedef JMemory_t< JClass_t >	memory_type

Public Member Functions
virtual void	reset () override
	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.
template<class T >
void	reset (const JPointer< T > &pointer)
	Reset pointer.
virtual JClass_t *	get () const override
	Get pointer.
virtual void	set (JClass_t *p) override
	Set pointer.
template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer.
void	reset (JClass_t *p)
	Reset 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	release ()
	Release memory.

Protected Attributes
JClass_t *	__p
	pointer to object

Detailed Description

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

Template storage class.

This class extends the JPointer class with storage capabilities. The first template argument refers to the data type pointed to and the second (optional argument) to the memory management policy (see e.g. JMemory.hh). The method create() can be used to allocate memory; the method reset() releases the allocated memory.

Definition at line 26 of file JStorage.hh.

Member Typedef Documentation

pointer_type

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

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

Definition at line 32 of file JStorage.hh.

memory_type

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

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

Definition at line 33 of file JStorage.hh.

Member Function Documentation

reset() [1/3]

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

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

inlineoverridevirtual

Reset pointer.

The allocated memory is released.

Reimplemented from JLANG::JPointer< JClass_t >.

Reimplemented in JLANG::JSharedPointer< JClass_t, JMemory_t >, JLANG::JSharedPointer< JAbstractAutoPointer< JBase_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< Evt > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JDAQSummaryslice > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JHead_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTail_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTypeList< JDAQEvent, JNullType > > >, JLANG::JSharedPointer< JAccessibleObjectIterator< KM3NETDAQ::JDAQEvent > >, JLANG::JSharedPointer< JAccessibleObjectIterator< T > >, JLANG::JSharedPointer< JAccessibleObjectOutput< T > >, JLANG::JSharedPointer< JBase_t >, JLANG::JSharedPointer< JFIT::JMEstimator >, JLANG::JSharedPointer< JLOGGER::JLogger >, JLANG::JSharedPointer< JNET::JControlHost >, JLANG::JSharedPointer< JObjectIterator< T > >, JLANG::JSharedPointer< JObjectOutput< JHead_t > >, JLANG::JSharedPointer< JObjectOutput< JTail_t > >, JLANG::JSharedPointer< JObjectOutput< T > >, JLANG::JSharedPointer< JParserElementInterface >, JLANG::JSharedPointer< JPropertiesElementInterface >, JLANG::JSharedPointer< JRadiation >, JLANG::JSharedPointer< JRewindableObjectIterator< const event_type > >, JLANG::JSharedPointer< JRewindableObjectIterator< JHead_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JTail_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< T > >, JLANG::JSharedPointer< JTOOLS::JMultiMapTransformer >, JLANG::JSharedPointer< JTRIGGER::JDAQHitSelector >, JLANG::JSharedPointer< JTRIGGER::JMatch >, and JLANG::JSharedPointer< match_type >.

Definition at line 42 of file JStorage.hh.

    { 
      if (this->is_valid()) {
        this->release();
      }
 
      pointer_type::reset();
    }

recreate()

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

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

inline

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]

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

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

inline

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]

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

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

inline

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]

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

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

inlineprotected

Release memory.

Definition at line 91 of file JStorage.hh.

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

reset() [2/3]

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

template<class T >

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

inline

Reset pointer.

Parameters

pointer

pointer to object

Definition at line 108 of file JPointer.hh.

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

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() [1/2]

template<class JClass_t >

virtual void JLANG::JPointer< JClass_t >::set ( JClass_t * p )

inlineoverridevirtualinherited

Set pointer.

Parameters

p	pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JSharedPointer< JClass_t, JMemory_t >, JLANG::JSharedPointer< JAbstractAutoPointer< JBase_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< Evt > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JDAQSummaryslice > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JHead_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTail_t > >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTypeList< JDAQEvent, JNullType > > >, JLANG::JSharedPointer< JAccessibleObjectIterator< KM3NETDAQ::JDAQEvent > >, JLANG::JSharedPointer< JAccessibleObjectIterator< T > >, JLANG::JSharedPointer< JAccessibleObjectOutput< T > >, JLANG::JSharedPointer< JBase_t >, JLANG::JSharedPointer< JFIT::JMEstimator >, JLANG::JSharedPointer< JLOGGER::JLogger >, JLANG::JSharedPointer< JNET::JControlHost >, JLANG::JSharedPointer< JObjectIterator< T > >, JLANG::JSharedPointer< JObjectOutput< JHead_t > >, JLANG::JSharedPointer< JObjectOutput< JTail_t > >, JLANG::JSharedPointer< JObjectOutput< T > >, JLANG::JSharedPointer< JParserElementInterface >, JLANG::JSharedPointer< JPropertiesElementInterface >, JLANG::JSharedPointer< JRadiation >, JLANG::JSharedPointer< JRewindableObjectIterator< const event_type > >, JLANG::JSharedPointer< JRewindableObjectIterator< JHead_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JTail_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< T > >, JLANG::JSharedPointer< JTOOLS::JMultiMapTransformer >, JLANG::JSharedPointer< JTRIGGER::JDAQHitSelector >, JLANG::JSharedPointer< JTRIGGER::JMatch >, and JLANG::JSharedPointer< match_type >.

Definition at line 75 of file JPointer.hh.

    {
      this->__p = p;
    }

set() [2/2]

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

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

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

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

Member Data Documentation

__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:

• JStorage.hh