TPositionInfoBase Class Reference

#include <lbspositioninfo.h>

Link against: lbs.lib

class TPositionInfoBase : public TPositionClassTypeBase

Inherits from

TPositionInfoBase
- TPositionClassTypeBase

Protected Attributes
TPositionModuleId	iModuleId
TPositionModuleInfo::TTechnologyType	iPositionMode
TPositionModeReason	iPositionModeReason
TUint32	iUpdateType

Public Member Functions
IMPORT_C TPositionModuleId	ModuleId()
IMPORT_C TPositionModuleInfo::TTechnologyType	PositionMode()
IMPORT_C TPositionModeReason	PositionModeReason()
IMPORT_C void	SetModuleId(TPositionModuleId)
IMPORT_C void	SetPositionMode(TPositionModuleInfo::TTechnologyType)
IMPORT_C void	SetPositionModeReason(TPositionModeReason)
IMPORT_C void	SetUpdateType(TPositionUpdateType)
IMPORT_C TPositionUpdateType	UpdateType()

Protected Member Functions
	TPositionInfoBase()

Inherited Attributes
	TPositionClassTypeBase::iPosClassSize
	TPositionClassTypeBase::iPosClassType

Inherited Functions
	TPositionClassTypeBase::PositionClassSize()const
	TPositionClassTypeBase::PositionClassType()const
	TPositionClassTypeBase::TPositionClassTypeBase()

Detailed Description

This class provides the interface used by RPositioner to get a location fix, and as such all classes used to get location info from the location server should derive from this class.

Class contains info about the update type and the ID of the module that gave the location fix

Member Attribute Documentation

iModuleId

TPositionModuleId

iModuleId

[protected]

The Id of the module that gave the location fix.

iPositionMode

TPositionModuleInfo::TTechnologyType

iPositionMode

[protected]

The positioning mode used to calculate this location fix.

iPositionModeReason

TPositionModeReason

iPositionModeReason

[protected]

The reason why the prefered position mode was not used.

iUpdateType

iUpdateType

[protected]

The type of update that this location fix represents.

Constructor & Destructor Documentation

TPositionInfoBase ( )

IMPORT_C

TPositionInfoBase

(

)

[protected]

Default constructor. Sets up class type information.

Member Function Documentation

ModuleId ( )

IMPORT_C TPositionModuleId

ModuleId

(

)

const

Returns the module Id of the module that gave the position fix

Return Value: Returns the module Id of the module that gave the position fix.

PositionMode ( )

IMPORT_C TPositionModuleInfo::TTechnologyType

PositionMode

(

)

const

see TPositionModuleInfo::TTechnologyType

Return Value: Returns the actual mode used by the positioning module to calculate the position fix. A positioning module may not always be able to use the preferred location calculation mode. For example, if preferred mode is "terminal-assisted" but the phone is out of network coverage it may have used autonomous mode instead.

PositionModeReason ( )

IMPORT_C TPositionModeReason

PositionModeReason

(

)

const

see PositionMode see _TPositionModeReason

Return Value: Returns why the positioning mode used to calculate the position fix was different from the prefered mode. For example, this could indicate that the phone is out of network coverage.The method returns a bit mask the reasons why the position module was unable calculate the position in the prefered mode. EPositionModeReasonNone is returned if the mode used was the preferred.EPositionModeReasonNetworkError is returned when there is no network coverage or the service is unavailable.EPositionModeReasonLocalError represents environmental reasons that prevent a terminal based calculation. For example, no satellites are in view.EPositionModeReasonDataError is returned when there is a problem with the initialisation data. For example, GPS assistance data was received but it was either invalid or could not be used.

SetModuleId ( TPositionModuleId )

IMPORT_C void

SetModuleId

(

TPositionModuleId

aModuleId

)

Sets the Module Id stored in this class

Parameters
aModuleId	Module Id stored in this class is set to aModuleId.

SetPositionMode ( TPositionModuleInfo::TTechnologyType )

IMPORT_C void

SetPositionMode

(

TPositionModuleInfo::TTechnologyType

aMode

)

see TPositionModuleInfo::TTechnologyType

Parameters
aMode	The mode used to calculate the position fix contained in this class. For example, terminal only (autonomous), terminal-assisted, network only or network-assisted.

SetPositionModeReason ( TPositionModeReason )

IMPORT_C void

SetPositionModeReason

(

TPositionModeReason

aReason

)

see TPositionModuleInfo::TTechnologyType

Parameters
aReason	The mode used to calculate the position fix contained in this class was different from the prefered mode.

SetUpdateType ( TPositionUpdateType )

IMPORT_C void

SetUpdateType

(

TPositionUpdateType

aUpdateType

)

Sets The update type of the position fix in this class

Parameters
aUpdateType	The update type of the position fix in this class is set to this.

UpdateType ( )

IMPORT_C TPositionUpdateType

UpdateType

(

)

const

Returns the update type of the position fix.

Return Value: Returns the update type of the position fix.