Collapse all Symbian^3 Application Developer Library

TLbsLocRequestQuality Class Reference

class TLbsLocRequestQuality : public TLbsLocClassTypeBase

Specifies the desired quality of a location request The TLbsLocRequestQuality is used by the location source observer to specify the desired quality of a location request. An instance of the class is passed to CLbsLocationSourceGpsBase::RequestLocationUpdate() .

The parameters in TLbsLocRequestQuality include the desired minimum horizontal and vertical accuracy for the requested location update. It also enables a maximum time to be specified. This is a time limit indicating the maximum time the data source should take to calculate the location.

It is possible to combine both the desired minimum accuracy and the maximum time. In this situation the data source module will respond either when the desired accuracy has been reached or when the time limit has expired. CLbsLocationSourceBase::RequestLocationUpdate() MLbsLocationSourceObserver

Inherits from

TLbsLocRequestQuality
- TLbsLocClassTypeBase

Public Member Functions
	TLbsLocRequestQuality ()
IMPORT_C TBool	AssistedClientRequestPresent ()
IMPORT_C TTimeIntervalMicroSeconds	MaxFixTime ()
IMPORT_C TReal32	MinHorizontalAccuracy ()
IMPORT_C TReal32	MinVerticalAccuracy ()
IMPORT_C void	SetAssistedClientRequestPresent ( TBool )
IMPORT_C void	SetMaxFixTime ( TTimeIntervalMicroSeconds )
IMPORT_C void	SetMinHorizontalAccuracy ( TReal32 )
IMPORT_C void	SetMinVerticalAccuracy ( TReal32 )

Inherited Functions
	TLbsLocClassTypeBase::ClassSize()const
	TLbsLocClassTypeBase::ClassType()const
	TLbsLocClassTypeBase::TLbsLocClassTypeBase()

Protected Attributes
TBool	iAssistedClientRequestPresent
TTimeIntervalMicroSeconds	iMaxFixTime
TReal32	iMinHorizontalAccuracy
TReal32	iMinVerticalAccuracy
TUint8	iReserved

Inherited Attributes
	TLbsLocClassTypeBase::iClassSize
	TLbsLocClassTypeBase::iClassType

Constructor & Destructor Documentation

TLbsLocRequestQuality()

IMPORT_C

TLbsLocRequestQuality

(

)

Constructor for the TLbsLocRequestQuality

CLbsLocationSourceGpsBase

Member Functions Documentation

AssistedClientRequestPresent()

IMPORT_C TBool

AssistedClientRequestPresent

(

)

const

Is the request, at least in part, coming from the client API? And is the client asking that assistance data should be retrieved?

MaxFixTime()

IMPORT_C TTimeIntervalMicroSeconds

MaxFixTime

(

)

const

Maximum time a data source should spend calculating the current location.

SetMaxFixTime

MinHorizontalAccuracy()

IMPORT_C TReal32

MinHorizontalAccuracy

(

)

const

Desired minimum horizontal accuracy for a location update. SetMaxFixTime

MinVerticalAccuracy()

IMPORT_C TReal32

MinVerticalAccuracy

(

)

const

Desired minimum vertical accuracy for a location update. SetMaxFixTime

SetAssistedClientRequestPresent(TBool)

IMPORT_C void

SetAssistedClientRequestPresent

(

TBool

aAssistedClientRequestPresent

)

Sets the flag to true if there is an outstanding request from the client API that is part of the current request and if this request (coming from the client) is an assisted request (non-autonomous)

Parameters

TBool aAssistedClientRequestPresent

SetMaxFixTime(TTimeIntervalMicroSeconds)

IMPORT_C void

SetMaxFixTime

(

TTimeIntervalMicroSeconds

aTime

)

Maximum time a data source should spend calculating the current location.

When used in conjunction with SetMinHorizontalAccuracy and/or SetMinVerticalAccuracy the data source will produce an update either when the desired accuracy has be met or when the time limit is reached.

SetMaxFixTime

Parameters

TTimeIntervalMicroSeconds aTime

specifies the maximum time that the data source should spend calculating the current location.

SetMinHorizontalAccuracy(TReal32)

IMPORT_C void

SetMinHorizontalAccuracy

(

TReal32

aAccuracy

)

Desired minimum horizontal accuracy for a location update.

When used in conjunction with SetMaxFixTime the data source will produce an update either when the desired accuracy is met or when the time limit is reached. SetMaxFixTime

Parameters

TReal32 aAccuracy

specifies the desired minimum horizontal accuracy (in metres) for a location update produced by the data source.

SetMinVerticalAccuracy(TReal32)

IMPORT_C void

SetMinVerticalAccuracy

(

TReal32

aAccuracy

)

Desired minimum vertical accuracy for a location update. When used in conjunction with SetMaxFixTime the data source will produce an update either when the desired accuracy is met or when the time limit is reached. SetMaxFixTime