Symbian^3 Product Developer Library >

TPositionSatelliteInfo Class Reference

class TPositionSatelliteInfo : public TPositionCourseInfo

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

Inherits from

Public Member Functions
TPositionSatelliteInfo()
IMPORT_C TIntAppendSatelliteData(const TSatelliteData &)
IMPORT_C voidClearSatellitesInView()
IMPORT_C TIntGetSatelliteData(TUint, TSatelliteData &)
IMPORT_C TReal32HorizontalDoP()
IMPORT_C TIntNumSatellitesInView()
IMPORT_C TIntNumSatellitesUsed()
IMPORT_C TTimeSatelliteTime()
IMPORT_C voidSetHorizontalDoP(TReal32)
IMPORT_C voidSetSatelliteTime(TTime)
IMPORT_C voidSetTimeDoP(TReal32)
IMPORT_C voidSetVerticalDoP(TReal32)
IMPORT_C TReal32TimeDoP()
IMPORT_C TReal32VerticalDoP()
Inherited Functions
TPositionClassTypeBase::PositionClassSize()const
TPositionClassTypeBase::PositionClassType()const
TPositionClassTypeBase::TPositionClassTypeBase()
TPositionCourseInfo::GetCourse(TCourse &)const
TPositionCourseInfo::SetCourse(const TCourse &)
TPositionCourseInfo::TPositionCourseInfo()
TPositionInfo::GetPosition(TPosition &)const
TPositionInfo::SetPosition(const TPosition &)
TPositionInfo::TPositionInfo()
TPositionInfoBase::ModuleId()const
TPositionInfoBase::PositionMode()const
TPositionInfoBase::PositionModeReason()const
TPositionInfoBase::SetModuleId(TPositionModuleId)
TPositionInfoBase::SetPositionMode(TPositionModuleInfo::TTechnologyType)
TPositionInfoBase::SetPositionModeReason(TPositionModeReason)
TPositionInfoBase::SetUpdateType(TPositionUpdateType)
TPositionInfoBase::TPositionInfoBase()
TPositionInfoBase::UpdateType()const
Protected Attributes
TReal32 iHorizontalDoPValue
TUint iNumSatellitesInView
TUint iNumSatellitesUsed
TTime iSatelliteTime
TFixedArray< TSatelliteData, KPositionMaxSatellitesInView >iSatellitesInView
TReal32 iTimeDoPValue
TReal32 iVerticalDoPValue
Private Attributes
TUint8 iReserved
Inherited Attributes
TPositionClassTypeBase::iPosClassSize
TPositionClassTypeBase::iPosClassType
TPositionCourseInfo::iCourse
TPositionInfo::iPosition
TPositionInfoBase::iModuleId
TPositionInfoBase::iPositionMode
TPositionInfoBase::iPositionModeReason
TPositionInfoBase::iUpdateType

Constructor & Destructor Documentation

TPositionSatelliteInfo()

IMPORT_CTPositionSatelliteInfo()

TPositionSatelliteInfo constructor.

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

Member Functions Documentation

AppendSatelliteData(const TSatelliteData &)

IMPORT_C TIntAppendSatelliteData(const TSatelliteData &aSatelliteData)

Appends satellite data

Parameters

const TSatelliteData & aSatelliteDataThe data to append

ClearSatellitesInView()

IMPORT_C voidClearSatellitesInView()

Reset the number of satellites in view

GetSatelliteData(TUint, TSatelliteData &)

IMPORT_C TIntGetSatelliteData(TUintaIndex,
TSatelliteData &aSatelliteData
)const

Gets satellite data by index into TSatelliteData

Parameters

TUint aIndexThe index of the satellite whose data is requested
TSatelliteData & aSatelliteDataThe TSatelliteData structure where the data will be placed

HorizontalDoP()

IMPORT_C TReal32HorizontalDoP()const

Returns the horizontal dilution of precision

NumSatellitesInView()

IMPORT_C TIntNumSatellitesInView()const

The number of satellites in view

NumSatellitesUsed()

IMPORT_C TIntNumSatellitesUsed()const

Returns the number of satellites used in the calculation

SatelliteTime()

IMPORT_C TTimeSatelliteTime()const

Returns the time according to the satellite

SetHorizontalDoP(TReal32)

IMPORT_C voidSetHorizontalDoP(TReal32aDoPValue)

Sets the horizontal dilution of precision

Parameters

TReal32 aDoPValueThe horizontal dilution of precision to be set

SetSatelliteTime(TTime)

IMPORT_C voidSetSatelliteTime(TTimeaTime)

Sets the satellite time

Parameters

TTime aTimeThe satellite time to be set

SetTimeDoP(TReal32)

IMPORT_C voidSetTimeDoP(TReal32aDoPValue)

Sets the time dilution of precision

Parameters

TReal32 aDoPValueThe time dilution of precision to be set

SetVerticalDoP(TReal32)

IMPORT_C voidSetVerticalDoP(TReal32aDoPValue)

Sets the vertical dilution of precision

Parameters

TReal32 aDoPValueThe vertical dilution of precision to be set

TimeDoP()

IMPORT_C TReal32TimeDoP()const

Returns the time dilution of precision

VerticalDoP()

IMPORT_C TReal32VerticalDoP()const

Returns the vertical dilution of precision

Member Data Documentation

TReal32 iHorizontalDoPValue

TReal32 iHorizontalDoPValue[protected]

The horizontal dilution of precision

TUint iNumSatellitesInView

TUint iNumSatellitesInView[protected]

The number of satellites in view

TUint iNumSatellitesUsed

TUint iNumSatellitesUsed[protected]

The number of satellites used

TUint8 iReserved

TUint8 iReserved[private]

Unused variable for future expansion.

TTime iSatelliteTime

TTime iSatelliteTime[protected]

The time according to the satellite

TFixedArray< TSatelliteData, KPositionMaxSatellitesInView > iSatellitesInView

TFixedArray< TSatelliteData, KPositionMaxSatellitesInView >iSatellitesInView[protected]

The satellites in view

TReal32 iTimeDoPValue

TReal32 iTimeDoPValue[protected]

The time dilution of precision

TReal32 iVerticalDoPValue

TReal32 iVerticalDoPValue[protected]

The vertical dilution of precision

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.