JLANG::JReference< JClass_t *const > Class Template Reference

Template specialisation of JReference class for pointer type. More...

#include <JReference.hh>

Public Member Functions
	JReference (JClass_t *const &pointer)
	Constructor. More...
	JReference (const JPointer< JClass_t > &pointer)
	Constructor. More...
const JClass_t &	getReference () const
	Get reference to object. More...
bool	is_valid () const
	Check validity of reference. More...
const JClass_t *	operator-> () const
	Smart pointer. More...
const JClass_t &	operator* () const
	Dereference operator. More...

Protected Attributes
JClass_t *const &	__pointer

Detailed Description

template<class JClass_t>
class JLANG::JReference< JClass_t *const >

Template specialisation of JReference class for pointer type.

Definition at line 193 of file JReference.hh.

Constructor & Destructor Documentation

template<class JClass_t >

JLANG::JReference< JClass_t *const >::JReference ( JClass_t *const &  pointer )

inline

Constructor.

Parameters

pointer

pointer

Definition at line 201 of file JReference.hh.

                                         :
      __pointer(pointer)
    {}

template<class JClass_t >

JLANG::JReference< JClass_t *const >::JReference ( const JPointer< JClass_t > &  pointer )

inline

Constructor.

Parameters

pointer

pointer object

Definition at line 211 of file JReference.hh.

                                                  :
      __pointer(pointer.getReference())
    {}

Member Function Documentation

template<class JClass_t >

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

inline

Get reference to object.

Returns

reference to object

Definition at line 221 of file JReference.hh.

    {
      return *__pointer;
    }

template<class JClass_t >

bool JLANG::JReference< JClass_t *const >::is_valid ( ) const

inline

Check validity of reference.

Returns

true if pointer not null; else false

Definition at line 232 of file JReference.hh.

    {
      return (__pointer != NULL);
    }

template<class JClass_t >

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

inline

Smart pointer.

Returns

pointer to object

Definition at line 243 of file JReference.hh.

    {
      if (__pointer == NULL)
        THROW(JNullPointerException, "JReference::operator->()");
      else
        return __pointer;
    }

template<class JClass_t >

const JClass_t& JLANG::JReference< JClass_t *const >::operator* ( ) const

inline

Dereference operator.

Returns

reference to object

Definition at line 257 of file JReference.hh.

    {
      if (__pointer == NULL)
        THROW(JNullPointerException, "JReference::operator*()");
      else
        return *__pointer;
    }

Member Data Documentation

template<class JClass_t >

JClass_t* const& JLANG::JReference< JClass_t *const >::__pointer

protected

Definition at line 266 of file JReference.hh.

---

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

• JReference.hh