Collapse all Symbian^3 Product Developer Library

OSRTCtxtPtr Class Reference

class OSRTCtxtPtr

Context reference counted pointer class. This class allows a context object to automatically be released when its reference count goes to zero. It is very similar to the standard C++ library auto_ptr smart pointer class but only works with an OSRTContext object.

Public Member Functions
	OSRTCtxtPtr(OSRTContext *)
	OSRTCtxtPtr(const OSRTCtxtPtr &)
	~OSRTCtxtPtr()
OSCTXT *	getCtxtPtr()
OSBOOL	isNull()
	operator OSRTContext *()
	operator const OSRTContext *()
OSRTContext *	operator->()
const OSRTContext *	operator->()
OSRTCtxtPtr &	operator=(const OSRTCtxtPtr &)
OSRTCtxtPtr &	operator=(OSRTContext *)
OSBOOL	operator==(const OSRTContext *)

Protected Attributes
OSRTContext *	mPointer

Constructor & Destructor Documentation

OSRTCtxtPtr(OSRTContext *)

OSRTCtxtPtr

(

OSRTContext *

rf = 0

)

[inline]

This constructor set the internal context pointer to the given value and, if it is non-zero, increases the reference count by one.

Parameters

OSRTContext * rf = 0

- Pointer to OSRTContext object

OSRTCtxtPtr(const OSRTCtxtPtr &)

OSRTCtxtPtr

(

const OSRTCtxtPtr &

)

[inline]

The copy constructor copies the pointer from the source pointer object and, if it is non-zero, increases the reference count by one.

Parameters

const OSRTCtxtPtr & o

- Reference to OSRTCtxtPtr object to be copied

~OSRTCtxtPtr()

~OSRTCtxtPtr

(

)

[inline, virtual]

The destructor decrements the reference counter to the internal context pointer object. The context object will delete itself if its reference count goes to zero.

Member Functions Documentation

getCtxtPtr()

OSCTXT *

getCtxtPtr

(

)

[inline]

This method returns the standard context pointer used in C function calls.

isNull()

OSBOOL

isNull

(

)

const [inline]

The isNull method returns TRUE if the underlying context pointer is NULL.

operator OSRTContext *()

operator OSRTContext *

(

)

[inline]

The 'OSRTContext*' operator returns the context object pointer.

operator const OSRTContext *()

operator const OSRTContext *

(

)

const [inline]

operator->()

OSRTContext *

operator->

(

)

[inline]

The '->' operator returns the context object pointer.

operator->()

const OSRTContext *

operator->

(

)

const [inline]

operator=(const OSRTCtxtPtr &)

OSRTCtxtPtr &

operator=

(

const OSRTCtxtPtr &

)

[inline]

This assignment operator assigns this OSRTCtxtPtr to another. The reference count of the context object managed by this object is first decremented. Then the new pointer is assigned and that object's reference count is incremented.