The template JSinglePointer class can be used to hold a pointer to an object. More...

#include <JSinglePointer.hh>

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

Public Types
typedef JPointer< JClass_t >	pointer_type

typedef JNew< JClass_t >	memory_type

Public Member Functions
	JSinglePointer ()
	Default constructor. More...

	JSinglePointer (const JSinglePointer &object)
	Copy constructor. More...

	JSinglePointer (JClass_t *p)
	Constructor. More...

	~JSinglePointer ()
	Destructor. More...

JSinglePointer &	operator= (const JSinglePointer &object)
	Assignment operator. More...

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

virtual void	reset () override
	Reset pointer. More...

virtual void	reset () override
	Reset pointer. More...

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

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

void	reset (JClass_t *p)
	Reset pointer. More...

void	recreate ()
	Recreate object in memory. More...

void	create ()
	Create object in memory. More...

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

virtual JClass_t *	get () const override
	Get pointer. More...

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

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

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

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

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

bool	is_valid () const
	Check validity of pointer. More...

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

	operator JClass_t * () const
	Type conversion operator. More...

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

Protected Member Functions
void	release ()
	Release memory. More...

Protected Attributes
JClass_t *	__p
	pointer to object More...

Detailed Description

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

The template JSinglePointer class can be used to hold a pointer to an object.

The object pointed to is deleted at destruction. It is possible to create a container with single pointers. The first template argument refers to the data type pointed to and the second to the memory management policy.

Definition at line 24 of file JSinglePointer.hh.

Member Typedef Documentation

◆ pointer_type

typedef JPointer<JClass_t> JLANG::JStorage< JClass_t, JNew >::pointer_type

inherited

Definition at line 32 of file JStorage.hh.

◆ memory_type

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

inherited

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

◆ JSinglePointer() [1/3]

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

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

inline

Default constructor.

Definition at line 32 of file JSinglePointer.hh.

33 {}

◆ JSinglePointer() [2/3]

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

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

inline

Copy constructor.

The ownership of the object pointed to is transferred to this single pointer.

Parameters

object single pointer

Definition at line 42 of file JSinglePointer.hh.

     {
       this->set(object.get());
  
       const_cast<JSinglePointer&>(object).set(NULL);
     }

◆ JSinglePointer() [3/3]

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

JLANG::JSinglePointer< JClass_t, JMemory_t >::JSinglePointer ( JClass_t * p )

inline

Constructor.

Parameters

p	pointer to object

Definition at line 55 of file JSinglePointer.hh.

     {
       this->set(p);
     }

◆ ~JSinglePointer()

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

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

inline

Destructor.

Definition at line 64 of file JSinglePointer.hh.

     {
       this->reset();
     }

Member Function Documentation

◆ operator=() [1/2]

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

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

inline

Assignment operator.

The object pointed to previously is deleted. The ownership of the object pointed to is transferred to this single pointer.

Parameters

object single pointer

Returns: this single pointer

Definition at line 78 of file JSinglePointer.hh.

     {
       if (this->get() != object.get()) {
  
         this->reset();
  
         if (object.is_valid()) {
  
           this->set(object.get());
  
           const_cast<JSinglePointer&>(object).set(NULL);
         }
       }
  
       return *this;
     }

◆ operator=() [2/2]

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

template<class JDerived_t >

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

inline

Assignment operator.

The object pointed to previously is deleted.

Parameters

p	pointer to derived class object

Returns: this single pointer

Definition at line 104 of file JSinglePointer.hh.

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

◆ reset() [1/5]

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

inlineoverridevirtualinherited

Reset pointer.

The allocated memory is released.

Reimplemented from JLANG::JPointer< JClass_t >.

Reimplemented in JLANG::JSharedPointer< JClass_t, JMemory_t >.

Definition at line 42 of file JStorage.hh.

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

◆ reset() [2/5]

virtual void JLANG::JPointer< JClass_t >::reset

inlineoverridevirtualinherited

Reset pointer.

Reimplemented from JLANG::JPointer< JClass_t >.

Definition at line 35 of file JPointer.hh.

     { 
       this->__p = NULL;
     }

◆ reset() [3/5]

void JLANG::JPointer< JClass_t >::reset ( class T )

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 35 of file JPointer.hh.

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

◆ reset() [4/5]

template<class JClass_t >

template<class T >

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

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 108 of file JPointer.hh.

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

◆ reset() [5/5]

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< JTypeList< JHead_t, JTail_t > >, JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JHead_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 >.

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

◆ 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

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

JSinglePointer.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

◆ pointer_type

◆ memory_type

Constructor & Destructor Documentation

◆ JSinglePointer() [1/3]

◆ JSinglePointer() [2/3]

◆ JSinglePointer() [3/3]

◆ ~JSinglePointer()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ reset() [1/5]

◆ reset() [2/5]

◆ reset() [3/5]

◆ reset() [4/5]

◆ reset() [5/5]

◆ recreate()

◆ create() [1/2]

◆ create() [2/2]

◆ release() [1/2]

◆ release() [2/2]

◆ get()

◆ set() [1/2]

◆ set() [2/2]

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ equals()

◆ is_valid()

◆ operator->()

◆ operator JClass_t *()

Member Data Documentation

◆ __p

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