MPosParameterObserver Class Reference

class MPosParameterObserver

Interface implemented by the Location Server to supply positioning related parameter values.

Member Functions Documentation

ExtendUpdateTimeOut(const TTimeIntervalMicroSeconds &)

void ExtendUpdateTimeOut ( const TTimeIntervalMicroSeconds & aAdditionalTime ) [pure virtual]

Extends the active request timeout by the value specified. Only the current active request is affected and the changes are not stored. That is the value returned by GetUpdateTimeOut and the default PSY timeout set by SetPsyDefaultUpdateTimeOut are not changed. This method is used, for example, to apply FNP lag.

Parameters

const TTimeIntervalMicroSeconds & aAdditionalTime

GetMaxAge(TTime &)

void GetMaxAge ( TTime & aMaxAge ) const [pure virtual]

Get the earliest allowed time of an old position fix, based on the current max age set by the client.

The PSY may save the result from the latest position request and return the same result in the next position request if the client says it's ok. Max age tells the PSY how old the stored position is allowed to be. If the stored position is too old or the PSY does not support max age, a normal positioning should be performed.

Parameters

TTime & aMaxAge On return, will contain the earliest allowed time of an old position fix. If no max age is defined aMaxAge will contain a time set to zero.

GetRequiredPositionQuality(TPositionQuality &)

TInt GetRequiredPositionQuality ( TPositionQuality & aPositionQuality ) const [pure virtual]

Get the quality of service requested by the client.

Parameters

TPositionQuality & aPositionQuality The requested quality of service.

GetUpdateTimeOut(TTimeIntervalMicroSeconds &)

void GetUpdateTimeOut ( TTimeIntervalMicroSeconds & aUpdateTimeOut ) const [pure virtual]

Returns the location update timeout associated with the subsession. The method returns a real timeout, which is defined and used by the Location Server. It may be different from the timeout set by the client or default PSY timeout.

Parameters

TTimeIntervalMicroSeconds & aUpdateTimeOut [Out] The location update timeout.

IsPartialUpdateAllowed()

TBool IsPartialUpdateAllowed ( ) const [pure virtual]

Checks if the client allows a partial position update.

A partial update result does not need to contain all parameters. The only mandatory parameters are latitude, longitude and time of fix. Everything else is optional.

If a partial update is returned to the client in a NotifyPositionUpdate call, the completion code must be set to KPositionPartialUpdate.

SetPsyDefaultUpdateTimeOut(const TTimeIntervalMicroSeconds &)

void SetPsyDefaultUpdateTimeOut ( const TTimeIntervalMicroSeconds & aUpdateTimeOut ) [pure virtual]

Called to inform the Location Server about the PSY default update timeout. The Location Server may use this value to calculate the update timeout it uses. When this method is called, it does not affect the currect request. So, it must be called in advance before a request comes from the Location Server.

Parameters

const TTimeIntervalMicroSeconds & aUpdateTimeOut [In] The PSY default location update timeout.