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

Constructor & Destructor Documentation

TLbsLocRequestQuality()

IMPORT_CTLbsLocRequestQuality()

Member Functions Documentation

AssistedClientRequestPresent()

IMPORT_C TBoolAssistedClientRequestPresent()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 TTimeIntervalMicroSecondsMaxFixTime()const

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

SetMaxFixTime

MinHorizontalAccuracy()

IMPORT_C TReal32MinHorizontalAccuracy()const

Desired minimum horizontal accuracy for a location update. SetMaxFixTime

MinVerticalAccuracy()

IMPORT_C TReal32MinVerticalAccuracy()const

Desired minimum vertical accuracy for a location update. SetMaxFixTime

SetAssistedClientRequestPresent(TBool)

IMPORT_C voidSetAssistedClientRequestPresent(TBoolaAssistedClientRequestPresent)

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 voidSetMaxFixTime(TTimeIntervalMicroSecondsaTime)

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 aTimespecifies the maximum time that the data source should spend calculating the current location.

SetMinHorizontalAccuracy(TReal32)

IMPORT_C voidSetMinHorizontalAccuracy(TReal32aAccuracy)

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 aAccuracyspecifies the desired minimum horizontal accuracy (in metres) for a location update produced by the data source.

SetMinVerticalAccuracy(TReal32)

IMPORT_C voidSetMinVerticalAccuracy(TReal32aAccuracy)

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

Parameters

TReal32 aAccuracyspecifies the desired minimum vertical accuracy (in metres) for a location update produced by the data source.

Member Data Documentation

TBool iAssistedClientRequestPresent

TBool iAssistedClientRequestPresent[protected]

Specifies if the client API has any outstanding request that requires assistance data that is part of the current request

TTimeIntervalMicroSeconds iMaxFixTime

TTimeIntervalMicroSeconds iMaxFixTime[protected]

Minimum time to wait for fix

TReal32 iMinHorizontalAccuracy

TReal32 iMinHorizontalAccuracy[protected]

Minimum horizonal accuracy

TReal32 iMinVerticalAccuracy

TReal32 iMinVerticalAccuracy[protected]

Minimum vertical accuracy

TUint8 iReserved

TUint8 iReserved[protected]

Reserved