RRef Class Reference

#include <e32std.h>

Link against: eposprvtyp.lib

class RRef : public RRefBase

Inherits from

RRef
- RRefBase

Public Member Functions
	RRef()
	RRef(const RRef< T > &)
void	Alloc(const T &)
void	Alloc(const T &, TInt)
void	AllocL(const T &)
void	AllocL(const T &, TInt)
	operator T *()
T *	operator->()
void	operator=(const RRef< T > &)

Inherited Attributes
	RRefBase::iPtr

Inherited Functions
	RRefBase::Copy(const RRefBase &)
	RRefBase::DoAlloc(const TAny *,TInt)
	RRefBase::DoAllocL(const TAny *,TInt)
	RRefBase::Free()
	RRefBase::RRefBase()
	RRefBase::RRefBase(const RRefBase &)

Detailed Description

Contains, or packages, a copy of an instance of another class.

The template parameter defines the type of the contained object.

The contained object is held in allocated memory, and can be accessed through the member selection and dereference operators.

Constructor & Destructor Documentation

RRef ( )

RRef

(

)

[inline]

Default constructor.

RRef ( const RRef< T > & )

RRef

(

const RRef< T > &

anObject

)

[inline]

Copy constructor.

The constructor frees any existing contained object, and takes ownership of the object owned by anObject.

Parameter	Description
anObject	A reference to another 'reference' object. On return from this constructor, anObject may be safely orphaned if it lives on the program stack.

Member Function Documentation

Alloc ( const T & )

void

Alloc

(

const T &

anObject

)

[inline]

Creates a copy of the specified object, which is to be contained by this reference object.

The amount of memory set aside to contain the object is defined by the size of the object

Parameter	Description
anObject	The object to be packaged up by this reference object.

Alloc ( const T &, TInt )

void	Alloc	(	const T &	anObject,
			TInt	aSize
		)	[inline]

Creates a copy of the specified object, which is to be contained by this reference object.

The amount of memory set aside to contain the object is defined by aSize.

Parameter	Description
anObject	The object to be packaged up by this reference object.
aSize	The amount of memory to be set aside to contain the object. You must make sure that this is big enough.

AllocL ( const T & )

void

AllocL

(

const T &

anObject

)

[inline]

Creates a copy of the specified object, which is to be contained by this reference object, and leaves on failure.

The amount of memory set aside to contain the object is defined by the size of the object

Parameter	Description
anObject	The object to be packaged up by this reference object.

AllocL ( const T &, TInt )

void	AllocL	(	const T &	anObject,
			TInt	aSize
		)	[inline]

Creates a copy of the specified object, which is to be contained by this reference object, and leaves on failure.

The amount of memory set aside to contain the object is defined by aSize.

Parameter	Description
anObject	The object to be packaged up by this reference object.
aSize	The amount of memory to be set aside to contain the object. You must make sure that this is big enough.

operator T * ( )

operator T *

(

)

[inline]

Gets a pointer to the contained object.

Returns: A pointer to the contained object

operator-> ( )

T *

operator->

(

)

[inline]

Gets a pointer to the contained object.

Returns: A pointer to the contained object

operator= ( const RRef< T > & )

void

operator=

(

const RRef< T > &

anObject

)

[inline]

Assignment operator.

The constructor frees any existing contained object, and takes ownership of the object owned by anObject.

Parameter	Description
anObject	A reference to another 'reference' object. On return from this constructor, anObject may be safely orphaned if it lives on the program stack.