TPckgBuf< T > Class Template Reference

Packages an object into a modifiable buffer descriptor. More...

#include <e32cmn.h>

Inheritance diagram for TPckgBuf< T >:

Public Member Functions
	TPckgBuf ()
	Constructs a packaged modifiable buffer descriptor for an object whose type is defined by the template parameter.
	TPckgBuf (const T &aRef)
	Constructs a packaged modifiable buffer descriptor for an object whose type is defined by the template parameter and copies the supplied object into the descriptor.
TPckgBuf &	operator= (const TPckgBuf< T > &aRef)
	Copies data from the specified packaged modifiable buffer descriptor into this packaged modifiable buffer descriptor, replacing any existing data.
T &	operator= (const T &aRef)
	Copies data from the specified object into this packaged modifiable buffer descriptor, replacing any existing data.
T &	operator() ()
	Gets a reference to the object contained by this packaged modifiable buffer descriptor.
const T &	operator() () const
	Gets a const reference to the object contained by this packaged modifiable buffer descriptor.

Detailed Description

template<class T>
class TPckgBuf< T >

Packages an object into a modifiable buffer descriptor.

The template parameter defines the type of object to be packaged.

The package provides a type safe way of transferring an object or data structure which is contained within a modifiable buffer descriptor. Typically, a package is used for passing data via inter thread communication.

The contained object is accessible through the package.

API status

Published to all clients. Released API.

Definition at line 1806 of file e32cmn.h.

Constructor & Destructor Documentation

TPckgBuf() [1/2]

template<class T >

TPckgBuf< T >::TPckgBuf ( )

inline

Constructs a packaged modifiable buffer descriptor for an object whose type is defined by the template parameter.

The length of the packaged descriptor is set to the length of the templated class but no data is assigned into the descriptor.

(generated from Symbian Developer Library)

TPckgBuf() [2/2]

template<class T >

TPckgBuf< T >::TPckgBuf ( const T &  aRef )

inline

Constructs a packaged modifiable buffer descriptor for an object whose type is defined by the template parameter and copies the supplied object into the descriptor.

The length of the packaged descriptor is set to the length of the templated class.

Parameters

aRef	The source object to be copied into the packaged modifiable buffer descriptor.

(generated from Symbian Developer Library)

Member Function Documentation

operator()() [1/2]

template<class T >

T & TPckgBuf< T >::operator() ( )

inline

Gets a reference to the object contained by this packaged modifiable buffer descriptor.

(generated from Symbian Developer Library)

operator()() [2/2]

template<class T >

const T & TPckgBuf< T >::operator() ( ) const

inline

Gets a const reference to the object contained by this packaged modifiable buffer descriptor.

(generated from Symbian Developer Library)

operator=() [1/2]

template<class T >

T & TPckgBuf< T >::operator= ( const T &  aRef )

inline

Copies data from the specified object into this packaged modifiable buffer descriptor, replacing any existing data.

Parameters

aRef	The source object.

(generated from Symbian Developer Library)

operator=() [2/2]

template<class T >

TPckgBuf & TPckgBuf< T >::operator= ( const TPckgBuf< T > &  aRef )

inline

Copies data from the specified packaged modifiable buffer descriptor into this packaged modifiable buffer descriptor, replacing any existing data.

Parameters

aRef	The source packaged modifiable buffer descriptor.

(generated from Symbian Developer Library)

---

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

• e32cmn.h
• e32cmn.h.dox