#include <LbsRequestor.h>
Link against: lbs.lib
Link against: lbsselflocate.lib

Class `CRequestorBase`

class CRequestorBase : public CBase;

Description

Each instance of a CRequestor class is used to hold the identity of one of the parties involved requesting the location. The class contains three data fields that indicate: (1) If the requesting party is a "service" or an actual person ("contact"). (2) A descriptor that identifiers the requestor and (3) a field that indicates which format the information is in

for example, a telephone number, URL or email address.

Derivation

CBase - Base class for all classes to be instantiated on the heap.

CRequestorBase - Each instance of a CRequestor class is used to hold the identity of one of the p...

Members

Defined in CRequestorBase:

CRequestorBase()Constructor for CRequestorBase.
ConstructL(TRequestorType,TRequestorFormat,const TDesC &)Second phase constructor. Must be called by all derived classes to initialise CR...
EFormatApplicationEFormatApplication
EFormatMailEFormatMail
EFormatTelephoneEFormatTelephone
EFormatUnknownRequestor format unknown
EFormatUrlEFormatUrl
ERequestorContactRequestor of type Contact
ERequestorServiceRequestor of type Service
ERequestorUnknownUnknown Requestor
ExtendedInterface(TInt,TAny *,TAny *)This method is used to allow polymorphic extensions to the API without breaking ...
ExternalizeL(RWriteStream &)constStores this requestors member data to a stream.
GetRequestor(TRequestorType &,TRequestorFormat &,TPtrC &)constSimple accessor for this requestors member data.
InternalizeL(RReadStream &)Restores this requestors member data from a stream.
RequestorData()constSimple accessor for this requestors member data.
RequestorFormat()constSimple accessor for this requestors member data.
RequestorType()constSimple accessor for this requestors member data.
SetRequestorL(TRequestorType,TRequestorFormat,const TDesC &)Replaces the requestor data for this object with the specified data.
TRequestorFormatdefined type for TRequestorFormat
TRequestorTypedefined type for TRequestorType
_TRequestorFormatTRequestorFormat
_TRequestorTypeTRequestorType
iFormatRequestor format
iRequestorTypeRequestor type
~CRequestorBase()Destructor for CRequestorBase.

Inherited from CBase:

Delete(CBase *)Deletes the specified object.
Extension_(TUint,TAny *&,TAny *)Extension function
operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TAny *)Initialises the object to binary zeroes.
operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Construction and destruction

`~CRequestorBase()`

IMPORT_C ~CRequestorBase();

Description

Destructor for CRequestorBase.

`CRequestorBase()`

protected: IMPORT_C CRequestorBase();

Description

Constructor for CRequestorBase.

`ConstructL(TRequestorType,TRequestorFormat,const TDesC &)`

protected: IMPORT_C void ConstructL(TRequestorType aType, TRequestorFormat aFormat, const TDesC &aData);

Description

Second phase constructor. Must be called by all derived classes to initialise CRequestorBase.

Parameters

`CRequestorBase::TRequestorType aType`	identifies the type of requestor, a service or a contact.
`CRequestorBase::TRequestorFormat aFormat`	determines the type of data held in aData
`const TDesC16 &aData`	is requestor data. Can be a telephone number, a URL etc.

Member functions

`SetRequestorL(TRequestorType,TRequestorFormat,const TDesC &)`

IMPORT_C void SetRequestorL(TRequestorType aType, TRequestorFormat aFormat, const TDesC &aData);

Description

Replaces the requestor data for this object with the specified data.

Parameters

`CRequestorBase::TRequestorType aType`	identifies the type of requestor, a service or a contact.
`CRequestorBase::TRequestorFormat aFormat`	determines the type of data held in aData
`const TDesC16 &aData`	is requestor data. Can be a telephone number, a URL etc.

`GetRequestor(TRequestorType &,TRequestorFormat &,TPtrC &)const`

IMPORT_C void GetRequestor(TRequestorType &aType, TRequestorFormat &aFormat, TPtrC &aData) const;

Description

Simple accessor for this requestors member data.

Parameters

`CRequestorBase::TRequestorType &aType`	will be set to the type of requestor.
`CRequestorBase::TRequestorFormat &aFormat`	will be set to the type of data held in aData.
`TPtrC16 &aData`	will be set to point to this requestors data.

`RequestorType()const`

IMPORT_C TRequestorType RequestorType() const;

Description

Simple accessor for this requestors member data.

Return value

CRequestorBase::TRequestorType

the type of requestor, a service or a contact.

`RequestorFormat()const`

IMPORT_C TRequestorFormat RequestorFormat() const;

Description

Simple accessor for this requestors member data.

Return value

CRequestorBase::TRequestorFormat

the type of data held in this requestor.

`RequestorData()const`

IMPORT_C TDesC& RequestorData() const;

Description

Simple accessor for this requestors member data.

Return value

TDesC16 &

the requestor data.

`InternalizeL(RReadStream &)`

IMPORT_C virtual void InternalizeL(RReadStream &aStream);

Description

Restores this requestors member data from a stream.

Parameters


                                 						RReadStream &aStream

the stream from which the requestors data is read.

`ExternalizeL(RWriteStream &)const`

IMPORT_C virtual void ExternalizeL(RWriteStream &aStream) const;

Description

Stores this requestors member data to a stream.

Parameters


                                 						RWriteStream &aStream

the stream to which the requestors data is written.

`ExtendedInterface(TInt,TAny ,TAny )`

protected: IMPORT_C virtual TAny* ExtendedInterface(TInt aFunctionNumber, TAny *aPtr1, TAny *aPtr2);

Description

This method is used to allow polymorphic extensions to the API without breaking BC. See documentation for explanation.

Parameters

`TInt aFunctionNumber`	contains the Id of the function to be invoked.
`TAny *aPtr1`	a pointer to any data
`TAny *aPtr2`	a pointer to any data.

Return value

TAny *

TAny* a pointer to any function

Member enumerations

Enum `_TRequestorType`

_TRequestorType

Description

TRequestorType

`ERequestorUnknown`	Unknown Requestor
`ERequestorService`	Requestor of type Service
`ERequestorContact`	Requestor of type Contact

Enum `_TRequestorFormat`

_TRequestorFormat

Description

TRequestorFormat

`EFormatUnknown`	Requestor format unknown
`EFormatApplication`	EFormatApplication
`EFormatTelephone`	EFormatTelephone
`EFormatUrl`	EFormatUrl
`EFormatMail`	EFormatMail

Member type definitions

Typedef `TRequestorType`

typedef TInt CRequestorBase::TRequestorType;

Description

defined type for TRequestorType

Typedef `TRequestorFormat`

typedef TInt CRequestorBase::TRequestorFormat;

Description

defined type for TRequestorFormat

Member data

`iRequestorType`

protected: TRequestorType iRequestorType;

Description

Requestor type

`iFormat`

protected: TRequestorFormat iFormat;

Description

Requestor format

Class CRequestorBase

Description

Derivation

Members

Construction and destruction

~CRequestorBase()

Description

CRequestorBase()

Description

ConstructL(TRequestorType,TRequestorFormat,const TDesC &)

Description

Parameters

Member functions

SetRequestorL(TRequestorType,TRequestorFormat,const TDesC &)

Description

Parameters

GetRequestor(TRequestorType &,TRequestorFormat &,TPtrC &)const

Description

Parameters

RequestorType()const

Description

Return value

RequestorFormat()const

Description

Return value

RequestorData()const

Description

Return value

InternalizeL(RReadStream &)

Description

Parameters

ExternalizeL(RWriteStream &)const

Description

Parameters

ExtendedInterface(TInt,TAny *,TAny *)

Description

Parameters

Return value

Member enumerations

Enum _TRequestorType

Description

Enum _TRequestorFormat

Description

Member type definitions

Typedef TRequestorType

Description

Typedef TRequestorFormat

Description

Member data

iRequestorType

Description

iFormat

Description

Class `CRequestorBase`

`~CRequestorBase()`

`CRequestorBase()`

`ConstructL(TRequestorType,TRequestorFormat,const TDesC &)`

`SetRequestorL(TRequestorType,TRequestorFormat,const TDesC &)`

`GetRequestor(TRequestorType &,TRequestorFormat &,TPtrC &)const`

`RequestorType()const`

`RequestorFormat()const`

`RequestorData()const`

`InternalizeL(RReadStream &)`

`ExternalizeL(RWriteStream &)const`

`ExtendedInterface(TInt,TAny ,TAny )`

Enum `_TRequestorType`

Enum `_TRequestorFormat`

Typedef `TRequestorType`

Typedef `TRequestorFormat`

`iRequestorType`

`iFormat`