TPositionInfoBase in LOCATIONFRAMEWORK

class TPositionInfoBase : public TPositionClassTypeBase;

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

Derivation

TPositionClassTypeBase - The base class for classes used to store position information

TPositionInfoBase - 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

Members

Defined in TPositionInfoBase:
ModuleId(), PositionMode(), PositionModeReason(), SetModuleId(), SetPositionMode(), SetPositionModeReason(), SetUpdateType(), TPositionInfoBase(), UpdateType(), iModuleId, iPositionMode, iPositionModeReason, iUpdateType

Inherited from TPositionClassTypeBase:
PositionClassSize(), PositionClassType(), iPosClassSize, iPosClassType

protected: IMPORT_C TPositionInfoBase();

Description

Default constructor. Sets up class type information.

IMPORT_C TPositionModuleId ModuleId() const;

Description

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

Return value

TPositionModuleId

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

IMPORT_C void SetModuleId(TPositionModuleId aModuleId);

Description

Sets the Module Id stored in this class

Parameters


TPositionModuleId aModuleId

Module Id stored in this class is set to aModuleId.

IMPORT_C TPositionUpdateType UpdateType() const;

Description

Returns the update type of the position fix.

Return value

TPositionUpdateType

Returns the update type of the position fix.

IMPORT_C void SetUpdateType(TPositionUpdateType aUpdateType);

Description

Sets The update type of the position fix in this class

Parameters


TPositionUpdateType aUpdateType

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

IMPORT_C TPositionModuleInfo::TTechnologyType PositionMode() const;

Description

see TPositionModuleInfo::TTechnologyType

Return value

TPositionModuleInfo::TTechnologyType

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.

IMPORT_C void SetPositionMode(TPositionModuleInfo::TTechnologyType aMode);

Description

see TPositionModuleInfo::TTechnologyType

Parameters


TPositionModuleInfo::TTechnologyType 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.

IMPORT_C TPositionModeReason PositionModeReason() const;

Description

see PositionMode see _TPositionModeReason

Return value

TPositionModeReason

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.

IMPORT_C void SetPositionModeReason(TPositionModeReason aReason);

Description

see TPositionModuleInfo::TTechnologyType

Parameters


TPositionModeReason aReason

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

protected: TPositionModuleId iModuleId;

Description

The Id of the module that gave the location fix.

protected: TUint32 iUpdateType;

Description

The type of update that this location fix represents.

protected: TPositionModuleInfo::TTechnologyType iPositionMode;

Description

The positioning mode used to calculate this location fix.

protected: TPositionModeReason iPositionModeReason;

Description

The reason why the prefered position mode was not used.

Class TPositionInfoBase

Description

Derivation

Members

Construction and destruction