Jpp  17.1.0
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
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
pointerpointer

Definition at line 201 of file JReference.hh.

201  :
202  __pointer(pointer)
203  {}
template<class JClass_t >
JLANG::JReference< JClass_t *const >::JReference ( const JPointer< JClass_t > &  pointer)
inline

Constructor.

Parameters
pointerpointer object

Definition at line 211 of file JReference.hh.

211  :
212  __pointer(pointer.getReference())
213  {}
JClass_t *const & getReference() const
Get rereference to internal pointer.
Definition: JPointer.hh:119

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.

222  {
223  return *__pointer;
224  }
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.

233  {
234  return (__pointer != NULL);
235  }
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.

244  {
245  if (__pointer == NULL)
246  throw JNullPointerException("JReference::operator->()");
247  else
248  return __pointer;
249  }
Exception for null pointer operation.
Definition: JException.hh:216
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.

258  {
259  if (__pointer == NULL)
260  throw JNullPointerException("JReference::operator*()");
261  else
262  return *__pointer;
263  }
Exception for null pointer operation.
Definition: JException.hh:216

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: