Collapse all Symbian^3 Application Developer Library

TPositionSatelliteInfo Class Reference

class TPositionSatelliteInfo : public TPositionCourseInfo

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

Inherits from

TPositionSatelliteInfo
- TPositionCourseInfo
  - TPositionInfo
    - TPositionInfoBase
      - TPositionClassTypeBase

Public Member Functions
	TPositionSatelliteInfo ()
IMPORT_C TInt	AppendSatelliteData (const TSatelliteData &)
IMPORT_C void	ClearSatellitesInView ()
IMPORT_C TInt	GetSatelliteData ( TUint , TSatelliteData &)
IMPORT_C TReal32	HorizontalDoP ()
IMPORT_C TInt	NumSatellitesInView ()
IMPORT_C TInt	NumSatellitesUsed ()
IMPORT_C TTime	SatelliteTime ()
IMPORT_C void	SetHorizontalDoP ( TReal32 )
IMPORT_C void	SetSatelliteTime ( TTime )
IMPORT_C void	SetTimeDoP ( TReal32 )
IMPORT_C void	SetVerticalDoP ( TReal32 )
IMPORT_C TReal32	TimeDoP ()
IMPORT_C TReal32	VerticalDoP ()

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_C

TPositionSatelliteInfo

(

)

TPositionSatelliteInfo constructor.

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

Member Functions Documentation

AppendSatelliteData(const TSatelliteData &)

IMPORT_C TInt

AppendSatelliteData

(

const TSatelliteData &

aSatelliteData

)

Appends satellite data

Parameters

const TSatelliteData & aSatelliteData

The data to append

ClearSatellitesInView()

IMPORT_C void

ClearSatellitesInView

(

)

Reset the number of satellites in view

GetSatelliteData(TUint, TSatelliteData &)

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

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

HorizontalDoP()

IMPORT_C TReal32

HorizontalDoP

(

)

const

Returns the horizontal dilution of precision

NumSatellitesInView()

IMPORT_C TInt

NumSatellitesInView

(

)

const

The number of satellites in view

NumSatellitesUsed()

IMPORT_C TInt

NumSatellitesUsed

(

)

const

Returns the number of satellites used in the calculation

SatelliteTime()

IMPORT_C TTime

SatelliteTime

(

)

const

Returns the time according to the satellite

SetHorizontalDoP(TReal32)

IMPORT_C void

SetHorizontalDoP

(

TReal32

aDoPValue

)

Sets the horizontal dilution of precision

Parameters

TReal32 aDoPValue

The horizontal dilution of precision to be set

SetSatelliteTime(TTime)

IMPORT_C void

SetSatelliteTime

(

TTime

aTime

)

Sets the satellite time

Parameters

TTime aTime

The satellite time to be set

SetTimeDoP(TReal32)

IMPORT_C void

SetTimeDoP

(

TReal32

aDoPValue

)

Sets the time dilution of precision

Parameters

TReal32 aDoPValue

The time dilution of precision to be set

SetVerticalDoP(TReal32)

IMPORT_C void

SetVerticalDoP

(

TReal32

aDoPValue

)

Sets the vertical dilution of precision

Parameters

TReal32 aDoPValue

The vertical dilution of precision to be set

TimeDoP()

IMPORT_C TReal32

TimeDoP

(

)

const

Returns the time dilution of precision

VerticalDoP()

IMPORT_C TReal32

VerticalDoP

(

)

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