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

• 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(const TSatelliteData &)Appends satellite data
• ClearSatellitesInView()Reset the number of satellites in view
• GetSatelliteData(TUint,TSatelliteData &)constGets satellite data by index into TSatelliteData
• HorizontalDoP()constReturns the horizontal dilution of precision
• NumSatellitesInView()constThe number of satellites in view
• NumSatellitesUsed()constReturns the number of satellites used in the calculation
• SatelliteTime()constReturns the time according to the satellite
• SetHorizontalDoP(TReal32)Sets the horizontal dilution of precision
• SetSatelliteTime(TTime)Sets the satellite time
• SetTimeDoP(TReal32)Sets the position dilution of precision
• SetVerticalDoP(TReal32)Sets the vertical dilution of precision
• TPositionSatelliteInfo()TPositionSatelliteInfo constructor.
• TimeDoP()constReturns the position dilution of precision
• VerticalDoP()constReturns the vertical dilution of precision
• iHorizontalDoPValueThe horizontal dilution of precision
• iNumSatellitesInViewThe number of satellites in view
• iNumSatellitesUsedThe number of satellites used
• iSatelliteTimeThe time according to the satellite
• iSatellitesInViewThe satellites in view
• iTimeDoPValueThe position dilution of precision
• iVerticalDoPValueThe vertical dilution of precision

Inherited from TPositionClassTypeBase:

• PositionClassSize()constPositionClassSize
• PositionClassType()constPositionClassTypeType
• iPosClassSizeThe size of the derived class
• iPosClassTypeThe type of the derived class

Inherited from TPositionCourseInfo:

• GetCourse(TCourse &)constGets the TCourse stored in this class
• SetCourse(const TCourse &)Sets the TCourse stored in this class
• iCourseThe TCourse.

Inherited from TPositionInfo:

• GetPosition(TPosition &)constGets the TPosition stored in this class
• SetPosition(const TPosition &)Sets the TPosition stored in this class
• iPositionThe TPosition.

Inherited from TPositionInfoBase:

• ModuleId()constReturns the module Id of the module that gave the position fix
• PositionMode()const see TPositionModuleInfo::TTechnologyType
• PositionModeReason()const see PositionMode see _TPositionModeReason
• SetModuleId(TPositionModuleId)Sets the Module Id stored in this class
• SetPositionModeReason(TPositionModeReason) see TPositionModuleInfo::TTechnologyType
• SetUpdateType(TPositionUpdateType)Sets The update type of the position fix in this class
• UpdateType()constReturns the update type of the position fix.
• iModuleIdThe Id of the module that gave the location fix.
• iPositionModeThe positioning mode used to calculate this location fix.
• iPositionModeReasonThe reason why the prefered position mode was not used.
• iUpdateTypeThe type of update that this location fix represents.

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

Return value

IMPORT_C TInt AppendSatelliteData(const TSatelliteData &aSatelliteData);

Description

Appends satellite data

Parameters

Return value

IMPORT_C TInt NumSatellitesInView() const;

Description

The number of satellites in view

Return value

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

IMPORT_C TTime SatelliteTime() const;

Description

Returns the time according to the satellite

Return value

IMPORT_C void SetSatelliteTime(TTime aTime);

Description

Sets the satellite time

Parameters

IMPORT_C TReal32 HorizontalDoP() const;

Description

Returns the horizontal dilution of precision

Return value

IMPORT_C TReal32 VerticalDoP() const;

Description

Returns the vertical dilution of precision

Return value

IMPORT_C TReal32 TimeDoP() const;

Description

Returns the position dilution of precision

Return value

IMPORT_C void SetHorizontalDoP(TReal32 aDoPValue);

Description

Sets the horizontal dilution of precision

Parameters

IMPORT_C void SetVerticalDoP(TReal32 aDoPValue);

Description

Sets the vertical dilution of precision

Parameters

IMPORT_C void SetTimeDoP(TReal32 aDoPValue);

Description

Sets the position dilution of precision

Parameters

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