Class TPositionSatelliteInfo

class TPositionSatelliteInfo : public TPositionCourseInfo;

Description

This class is used to store information about positions obtained by satellites.

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

• TPositionInfo - Standard class for getting a TPosition location fix from the location server

• TPositionCourseInfo - Class for getting a TCourse from the location server

• TPositionSatelliteInfo - This class is used to store information about positions obtained by satellites

Members

Defined in TPositionSatelliteInfo:
AppendSatelliteData(), ClearSatellitesInView(), GetSatelliteData(), HorizontalDoP(), NumSatellitesInView(), NumSatellitesUsed(), SatelliteTime(), SetHorizontalDoP(), SetSatelliteTime(), SetTimeDoP(), SetVerticalDoP(), TPositionSatelliteInfo(), TimeDoP(), VerticalDoP(), iHorizontalDoPValue, iNumSatellitesInView, iNumSatellitesUsed, iSatelliteTime, iSatellitesInView, iTimeDoPValue, iVerticalDoPValue

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

Inherited from TPositionCourseInfo:
GetCourse(), SetCourse(), iCourse

Inherited from TPositionInfo:
GetPosition(), SetPosition(), iPosition

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

IMPORT_C TPositionSatelliteInfo();

Description

TPositionSatelliteInfo constructor.

Note the the horizontal and vertical dilution of precision values are initially NaN.

IMPORT_C TInt GetSatelliteData(TUint aIndex, TSatelliteData &aSatelliteData) const;

Description

Gets satellite data by index into TSatelliteData

Parameters

TUint aIndex The index of the satellite whose data is requested TSatelliteData &aSatelliteData The TSatelliteData structure where the data will be placed

Return value

TInt KErrNone if successful, KErrNotFound otherwise

IMPORT_C TInt AppendSatelliteData(const TSatelliteData &aSatelliteData);

Description

Appends satellite data

Parameters

const TSatelliteData &aSatelliteData The data to append

Return value

TInt KErrNone if successful, KErrOverflow otherwise

IMPORT_C TInt NumSatellitesInView() const;

Description

The number of satellites in view

Return value

TInt The number of satellites in view

IMPORT_C void ClearSatellitesInView();

Description

Reset the number of satellites in view

IMPORT_C TInt NumSatellitesUsed() const;

Description

Returns the number of satellites used in the calculation

Return value

TInt The number of satellites used in the calculation

IMPORT_C TTime SatelliteTime() const;

Description

Returns the time according to the satellite

Return value

TTime The time according to the satellite

IMPORT_C void SetSatelliteTime(TTime aTime);

Description

Sets the satellite time

Parameters

TTime aTime The satellite time to be set

IMPORT_C TReal32 HorizontalDoP() const;

Description

Returns the horizontal dilution of precision

Return value

TReal32 The horizontal dilution of precision

IMPORT_C TReal32 VerticalDoP() const;

Description

Returns the vertical dilution of precision

Return value

TReal32 The vertical dilution of precision

IMPORT_C TReal32 TimeDoP() const;

Description

Returns the position dilution of precision

Return value

TReal32 The position dilution of precision

IMPORT_C void SetHorizontalDoP(TReal32 aDoPValue);

Description

Sets the horizontal dilution of precision

Parameters

TReal32 aDoPValue The horizontal dilution of precision to be set

IMPORT_C void SetVerticalDoP(TReal32 aDoPValue);

Description

Sets the vertical dilution of precision

Parameters

TReal32 aDoPValue The vertical dilution of precision to be set

IMPORT_C void SetTimeDoP(TReal32 aDoPValue);

Description

Sets the position dilution of precision

Parameters

TReal32 aDoPValue The position dilution of precision to be set

protected: TUint iNumSatellitesInView;

Description

The number of satellites in view

protected: TUint iNumSatellitesUsed;

Description

The number of satellites used

protected: TTime iSatelliteTime;

Description

The time according to the satellite

protected: TReal32 iHorizontalDoPValue;

Description

The horizontal dilution of precision

protected: TReal32 iVerticalDoPValue;

Description

The vertical dilution of precision

protected: TReal32 iTimeDoPValue;

Description

The position dilution of precision

protected: TFixedArray< TSatelliteData, KPositionMaxSatellitesInView > iSatellitesInView;

Description

The satellites in view