elm::Ref< T > Class Template Reference

#include <elm/util/Ref.h>

Public Member Functions
	Ref (T *_ptr)
	Ref (const Ref< T > &ref)
	operator T & (void) const
T *	operator& (void) const
T &	operator* (void) const
T *	operator-> (void) const
Ref< T > &	operator= (T *_ptr)
Ref< T > &	operator= (const Ref< T > &ref)
Ref< T > &	operator= (const T &val)

Detailed Description

template<class T>
class elm::Ref< T >

This class allows handling pointer as references but they provide assignment operators.

Parameters

T	Pointe type.

Constructor & Destructor Documentation

template<class T>

elm::Ref< T >::Ref

(

T *

_ptr

)

Build a new reference.

Parameters

_ptr	Pointer to store in.

template<class T>

elm::Ref< T >::Ref

(

const Ref< T > &

ref

)

Cloning constructor.

Parameters

ref	Cloned reference.

Member Function Documentation

template<class T>

elm::Ref< T >::operator T &

(

void

)

const

Automatic conversion to reference.

Returns

Reference on pointed object.

template<class T>

T * elm::Ref< T >::operator&

(

void

)

const

Get the stored pointer.

Returns

Stored pointer.

template<class T>

T& elm::Ref< T >::operator*

(

void

)

const

template<class T>

T * elm::Ref< T >::operator->

(

void

)

const

Only way to perform unreference with structure and objects.

Returns

Pointer on object.

template<class T>

Ref & elm::Ref< T >::operator=

(

T *

_ptr

)

Assignment with a pointer.

Parameters

_ptr	Assigned pointer.

Returns

Current object.

template<class T>

Ref & elm::Ref< T >::operator=

(

const Ref< T > &

ref

)

Assignment with a reference.

Parameters

ref	Assigned reference.

Returns

Current object.

template<class T>

Ref< T > & elm::Ref< T >::operator=

(

const T &

val

)

Assignment of the pointed value.

Parameters

val	Assigned value.

Returns

Current object.

---

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

• include/elm/util/Ref.h
• src/util_Ref.cpp