Template implementation of class that holds pointer to object(s). More...

#include <JPointer.hh>

Inheritance diagram for JLANG::JPointer< JClass_t >:

Public Member Functions
	JPointer ()
	Default constructor.

	JPointer (JClass_t *p)
	Constructor.

template<class T >
	JPointer (JPointer< T > pointer)
	Constructor.

virtual JClass_t *	get () const override
	Get pointer.

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

virtual void	reset () override
	Reset pointer.

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

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

void	reset (JClass_t *p)
	Reset pointer.

bool	is_valid () const
	Check validity of pointer.

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

	operator JClass_t * () const
	Type conversion operator.

Protected Attributes
JClass_t *	__p
	pointer to object

Detailed Description

template<class JClass_t>
class JLANG::JPointer< JClass_t >

Template implementation of class that holds pointer to object(s).

This class implements the JAbstractPointer interface.

Definition at line 22 of file JPointer.hh.

Constructor & Destructor Documentation

◆ JPointer() [1/3]

template<class JClass_t >

JLANG::JPointer< JClass_t >::JPointer ( )

inline

Default constructor.

Definition at line 33 of file JPointer.hh.

               :
      __p(NULL)
    {}

◆ JPointer() [2/3]

template<class JClass_t >

JLANG::JPointer< JClass_t >::JPointer ( JClass_t * p )

inline

Constructor.

Parameters

p	pointer to object

Definition at line 43 of file JPointer.hh.

                          :
      __p(p)
    {}

◆ JPointer() [3/3]

template<class JClass_t >

template<class T >

JLANG::JPointer< JClass_t >::JPointer ( JPointer< T > pointer )

inline

Constructor.

Parameters

pointer pointer to object

Definition at line 54 of file JPointer.hh.

                                  :
      __p(pointer.get())
    {}

Member Function Documentation

◆ get()

template<class JClass_t >

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

inlineoverridevirtual

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 )

inlineoverridevirtual

Set pointer.

Parameters

p	pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Definition at line 75 of file JPointer.hh.

    {
      this->__p = p;
    }

◆ reset() [1/3]

template<class JClass_t >

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

inlineoverridevirtual

Reset pointer.

Implements JLANG::JAbstractPointer< JClass_t >.

Definition at line 84 of file JPointer.hh.

    { 
      this->__p = NULL;
    }

◆ set() [2/2]

template<class JClass_t >

template<class T >

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

inline

Set pointer.

Parameters

pointer pointer to object

Definition at line 96 of file JPointer.hh.

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

◆ reset() [2/3]

template<class JClass_t >

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

◆ getReference() [1/2]

template<class JClass_t >

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

inline

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

inline

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

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

◆ 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

protected

pointer to object

Definition at line 136 of file JPointer.hh.

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

JPointer.hh

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JPointer() [1/3]

◆ JPointer() [2/3]

◆ JPointer() [3/3]

Member Function Documentation

◆ get()

◆ set() [1/2]

◆ reset() [1/3]

◆ set() [2/2]

◆ reset() [2/3]

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ equals()

◆ reset() [3/3]

◆ is_valid()

◆ operator->()

◆ operator JClass_t *()

Member Data Documentation

◆ __p