TPositionUpdateOptionsBase Class Reference

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 <LbsCommon.h>

Inherits TPositionClassTypeBase.

Inherited by TPositionUpdateOptions.

Detailed Description

The base class for classes storing position update options This class is used to change the behavior of RPositioner::NotifyPositionUpdate().

It enables the client application to request periodic updates. It can also be used to inform the positioning module that the client application will accept partial (i.e. incomplete) position information


Public Member Functions
IMPORT_C void	SetUpdateInterval (TTimeIntervalMicroSeconds aInterval)
	This method allows the client application to specify if it wants to receive updates at regular intervals.
IMPORT_C void	SetUpdateTimeOut (TTimeIntervalMicroSeconds aTimeOut)
	This method allows the client application to specify the timeout for RPositioner::NotifyPositionUpdate() request.
IMPORT_C void	SetMaxUpdateAge (TTimeIntervalMicroSeconds aMaxAge)
	This method allows the client application to specify the maximum age for the position information returned from RPositioner::NotifyPositionUpdate() request.
IMPORT_C TTimeIntervalMicroSeconds	UpdateInterval () const
	Get the current update interval value.
IMPORT_C TTimeIntervalMicroSeconds	UpdateTimeOut () const
	Get the current timeout interval value.
IMPORT_C TTimeIntervalMicroSeconds	MaxUpdateAge () const
	Get the current maximum age value.
Protected Member Functions
IMPORT_C	TPositionUpdateOptionsBase ()
IMPORT_C	TPositionUpdateOptionsBase (TTimeIntervalMicroSeconds aInterval, TTimeIntervalMicroSeconds aTimeOut=TTimeIntervalMicroSeconds(0), TTimeIntervalMicroSeconds aMaxAge=TTimeIntervalMicroSeconds(0))
Protected Attributes
TTimeIntervalMicroSeconds	iUpdateInterval
	The update interval.
TTimeIntervalMicroSeconds	iUpdateTimeOut
	The update timeout.
TTimeIntervalMicroSeconds	iMaxUpdateAge
	The maximum update age.

Constructor & Destructor Documentation

IMPORT_C TPositionUpdateOptionsBase::TPositionUpdateOptionsBase ( ) [protected]

IMPORT_C TPositionUpdateOptionsBase::TPositionUpdateOptionsBase	(	TTimeIntervalMicroSeconds	aInterval,
		TTimeIntervalMicroSeconds	aTimeOut = `TTimeIntervalMicroSeconds(0)`,
		TTimeIntervalMicroSeconds	aMaxAge = `TTimeIntervalMicroSeconds(0)`
	)	`[protected]`

Member Function Documentation

IMPORT_C TTimeIntervalMicroSeconds TPositionUpdateOptionsBase::MaxUpdateAge

(

)

const

Get the current maximum age value.

Returns:: The maximum update age

Note:: this returns only the value within this class object.

Precondition:: The client should have called RPositioner::GetUpdateOptions() to obtain the current maxage for this session.

IMPORT_C void TPositionUpdateOptionsBase::SetMaxUpdateAge

(

TTimeIntervalMicroSeconds

aMaxAge

)

This method allows the client application to specify the maximum age for the position information returned from RPositioner::NotifyPositionUpdate() request.

This means that position information can be returned from cache as long as the position is not older than the specified maximum age value.

Parameters:

aMaxAge

This parameter specifies the expiry time for the position information cache for this subsession. It means that when a position request is made the position information can be returned from the cache as long as the cache is not older that the specified maximum age.

Panic:: with "Lbs Client Fault" 12 if aMaxAge is negative.

Postcondition:: the client should invoke RPositioner::SetUpdateOptions() to set this option for the current session.

IMPORT_C void TPositionUpdateOptionsBase::SetUpdateInterval

(

TTimeIntervalMicroSeconds

aInterval

)

This method allows the client application to specify if it wants to receive updates at regular intervals.

This means that as long as the client re-issues the position request when the previous request is completed, the client receives position updates at the specified update interval periodicity.

Parameters:

aInterval

This parameter specifies the time interval after which the client wants a position update. Note that even after setting this value the client will have to call RPositioner::NotifyPositionUpdate() repeatedly to get position information. The Location Server only gurantees that even if the client makes a request immediately, the position information will be obtained and returned only after the specified update interval time.

If the previous value was zero and aInterval is set to a non-zero value then the periodic updates is started.
If the previous value was non-zero and aInterval is set to a different non-zero value then the new periodic update interval is updated.
If the aInterval was non-zero is set to zero then the periodic updates is stopped.

Panic:: "Lbs Client Fault" 12 if aInterval is negative.

Postcondition:: the client should invoke RPositioner::SetUpdateOptions() to set this option for the current session.

IMPORT_C void TPositionUpdateOptionsBase::SetUpdateTimeOut

(

TTimeIntervalMicroSeconds

aTimeOut

)

This method allows the client application to specify the timeout for RPositioner::NotifyPositionUpdate() request.

If the positioning module is unable to return a position fix within the specified timeout interval then the request is cancelled.

Parameters:

aTimeOut

This parameter specifies the timeout for a RPositioner::NotifyPositionUpdate() request.

Panic:: with "Lbs Client Fault" 12 if aTimeOut is negative.

Note:: When using a timeout, the application should also be aware of the time taken to obtain the initial fix and the time taken to obtain a subsequent fix of the positioning module that is being used to obtain the fixes. These values can be obtained by calling RPositionServer::GetModuleInfoById() method.