CRequestorBase Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

None

Exceptions

The capability Location is required in:

TInt RPositionServer::GetDefaultModuleId(TPositionModuleId& aModuleId) const;

TInt RPositionServer::GetNumModules(TUint& aNumModules) const;

TInt RPositionServer::GetModuleInfoByIndex(TInt aModuleIndex, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleInfoById(TPositionModuleId aModuleId, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleStatus(TPositionModuleStatusBase& aPosModuleStatus, TPositionModuleId aModuleId) const;

void RPositionServer::NotifyModuleStatusEvent(TPositionModuleStatusEventBase& aStatusEvent,TRequestStatus& aStatus,const TPositionModuleId aModuleId = KPositionNullModuleId) const;

TInt RPositioner::SetRequestor(CRequestor::TRequestorType aType,CRequestor::TRequestorFormat aFormat,const TDesC& aData);

TInt RPositioner::SetRequestor(const RRequestorStack& aRequestorStack);

TInt RPositioner::SetUpdateOptions(const TPositionUpdateOptionsBase& aPosOption);

TInt RPositioner::GetUpdateOptions(TPositionUpdateOptionsBase& aPosOption) const;

void RPositioner::GetLastKnownPosition(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

void RPositioner::NotifyPositionUpdate(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

#include <lbsrequestor.h>

Inherited by CRequestor.

Detailed Description

This is the base class for the requestor information class.


Public Types
typedef TInt	TRequestorType
	indicates the type of the requestor.
typedef TInt	TRequestorFormat
	indicates the format of the requestor.
enum	_TRequestorType { ERequestorUnknown, ERequestorService, ERequestorContact }
	Requestor types. More...
enum	_TRequestorFormat { EFormatUnknown, EFormatApplication, EFormatTelephone, EFormatUrl, EFormatMail }
	Requestor formats. More...
Public Member Functions
IMPORT_C	~CRequestorBase ()
	Destructor for CRequestorBase.
IMPORT_C void	SetRequestorL (TRequestorType aType, TRequestorFormat aFormat, const TDesC &aData)
	Set the type, format and string fields for this requestor object.
IMPORT_C void	GetRequestor (TRequestorType &aType, TRequestorFormat &aFormat, TPtrC &aData) const
	Obtain the type, format and string fields of this requestor object.
IMPORT_C TRequestorType	RequestorType () const
	Get the type field of the requestor.
IMPORT_C TRequestorFormat	RequestorFormat () const
	Get the format field of the requestor.
IMPORT_C TDesC &	RequestorData () const
	Get the requestor string field of this requestor.
virtual IMPORT_C void	InternalizeL (RReadStream &aStream)
	Read and store the type, format and requestor string from a stream.
virtual IMPORT_C void	ExternalizeL (RWriteStream &aStream) const
	Write the type, format and requestor string of this requestor to a stream.
Protected Member Functions
IMPORT_C	CRequestorBase ()
	default constructor
IMPORT_C void	ConstructL (TRequestorType aType, TRequestorFormat aFormat, const TDesC &aData)
	symbian 2nd phase constructor
virtual IMPORT_C TAny *	ExtendedInterface (TInt aFunctionNumber, TAny aPtr1, TAny aPtr2)
Protected Attributes
TRequestorType	iRequestorType
	The type of the requestor.
TRequestorFormat	iFormat
	The format of the requestor.

Member Typedef Documentation

CRequestorBase::TRequestorFormat

indicates the format of the requestor.

It is one of the enumerated values of CRequestorBase::_TRequestorFormat

CRequestorBase::TRequestorType

indicates the type of the requestor.

It is one of the enumerated values of CRequestorBase::_TRequestorType

Member Enumeration Documentation

enum CRequestorBase::_TRequestorFormat

Requestor formats.

Enumerator:

EFormatUnknown	unassigned value and should not be reported or used
EFormatApplication	Indicates that requestor data contains the textual name of an application. Used only if the requestor type is ERequestorService
EFormatTelephone	Indicates that requestor data contains a telephone number. This should be in the international format without spaces.
EFormatUrl	Indicates that requestor data contains an address in the URL format.
EFormatMail	Indicates that requestor data contains an email address in the standard format.

enum CRequestorBase::_TRequestorType

Requestor types.

Enumerator:

ERequestorUnknown	an unassigned value and should not be reported or used
ERequestorService	indicates that the request for location information originates from an application, network services or other entity. In particular, the requestor is not a person.
ERequestorContact	indicate that the request for location information originates from a person.

Constructor & Destructor Documentation

IMPORT_C CRequestorBase::~CRequestorBase

(

)

Destructor for CRequestorBase.

IMPORT_C CRequestorBase::CRequestorBase ( ) [protected]

default constructor

Member Function Documentation

IMPORT_C void CRequestorBase::ConstructL	(	TRequestorType	aType,
		TRequestorFormat	aFormat,
		const TDesC &	aData
	)	`[protected]`

symbian 2nd phase constructor

virtual IMPORT_C TAny* CRequestorBase::ExtendedInterface	(	TInt	aFunctionNumber,
		TAny *	aPtr1,
		TAny *	aPtr2
	)	`[protected, virtual]`

virtual IMPORT_C void CRequestorBase::ExternalizeL ( RWriteStream & aStream ) const [virtual]

Write the type, format and requestor string of this requestor to a stream.

Parameters:

[out] aStream the stream to which the requestor information is written.

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

Obtain the type, format and string fields of this requestor object.

The type field indicates whether the requestor is a service or a contact.
The format field indicates whether the string is a telephone number, URL or email address.
The requestor string is the data of the requestor.
Parameters:

[out] aType will be set to the type of the requestor.
[out] aFormat will be set to the format of the requestor.
[out] aData will be set to point to the requestor string.

virtual IMPORT_C void CRequestorBase::InternalizeL ( RReadStream & aStream ) [virtual]

Read and store the type, format and requestor string from a stream.

Parameters:

[in] aStream the stream from which the requestor information is read.

IMPORT_C TDesC& CRequestorBase::RequestorData

(

)

const

Get the requestor string field of this requestor.

The requestor string is a descriptor value.

Returns:: the requestor string.

IMPORT_C TRequestorFormat CRequestorBase::RequestorFormat

(

)

const

Get the format field of the requestor.

The format field indicates whether the requestor string is a telephone number, URL or email address.

Returns:: the format of data held in this requestor.

IMPORT_C TRequestorType CRequestorBase::RequestorType

(

)

const

Get the type field of the requestor.

The type field indicates whether the requestor is a service or a contact.

Returns:: the type of requestor, a service or a contact.

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

Set the type, format and string fields for this requestor object.

The type field indicates whether this requestor is a service or a contact.
The format field indicates whether the string is a telephone number, URL or email address.

The requestor string is the data of the requestor.

Parameters:

	aType	identifies the type of the requestor, a service or a contact.
	aFormat	identifies the format of the requestor.
`[in]`	aData	identifies the requestor string. The requestor string can be a telephone number, a URL etc.