Collapse all Symbian^3 Application Developer Library

TPositionGpsMeasurementInfo Class Reference

class TPositionGpsMeasurementInfo : public TPositionInfoBase

Class TPositionGpsMeasurementInfo is used to hold the complete set of satellite measurement data.

Inherits from

TPositionGpsMeasurementInfo
- TPositionInfoBase
  - TPositionClassTypeBase

Public Member Functions
	TPositionGpsMeasurementInfo ()
IMPORT_C TInt	AppendMeasurementData (const TPositionGpsMeasurementData &)
IMPORT_C void	ClearMeasurementData ()
IMPORT_C TInt	GetGpsTimingData ( TGpsTimingMeasurementData &)
IMPORT_C TInt	GetMeasurementData ( TUint , TPositionGpsMeasurementData &)
IMPORT_C TInt	GpsTimeOfWeek ()
IMPORT_C TInt	NumMeasurements ()
IMPORT_C TBool	PositionCalculationPossible ()
IMPORT_C void	SetGpsTimeOfWeek ( TInt )
IMPORT_C void	SetGpsTimingData (const TGpsTimingMeasurementData &)
IMPORT_C void	SetPositionCalculationPossible ( TBool )

Inherited Functions
	TPositionClassTypeBase::PositionClassSize()const
	TPositionClassTypeBase::PositionClassType()const
	TPositionClassTypeBase::TPositionClassTypeBase()
	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
TInt	iCalcPossible
TInt	iGpsTimeOfWeek
TGpsTimingMeasurementData	iGpsTimingMeasurementData
TFixedArray < TPositionGpsMeasurementData , KPositionGpsMaxMeasurements >	iMeasurementData
TUint	iNumMeasurements

Inherited Attributes
	TPositionClassTypeBase::iPosClassSize
	TPositionClassTypeBase::iPosClassType
	TPositionInfoBase::iModuleId
	TPositionInfoBase::iPositionMode
	TPositionInfoBase::iPositionModeReason
	TPositionInfoBase::iUpdateType

Constructor & Destructor Documentation

TPositionGpsMeasurementInfo()

IMPORT_C

TPositionGpsMeasurementInfo

(

)

TPositionGpsMeasurementInfo constructor. TPositionGpsMeasurementData TPositionInfoBase

Member Functions Documentation

AppendMeasurementData(const TPositionGpsMeasurementData &)

IMPORT_C TInt

AppendMeasurementData

(

const TPositionGpsMeasurementData &

aMeasurementData

)

Adds the supplied measurement data to the current list NumMeasurements GetMeasurementData

Parameters

const TPositionGpsMeasurementData & aMeasurementData

The data to append

ClearMeasurementData()

IMPORT_C void

ClearMeasurementData

(

)

Remove all satellite measurement data NumMeasurements GetMeasurementData

GetGpsTimingData(TGpsTimingMeasurementData &)

IMPORT_C TInt

GetGpsTimingData

(

TGpsTimingMeasurementData &

aGpsTimingData

)

const

Populates aGpsTimingData with the GPS Timing Measurement Data

Parameters

TGpsTimingMeasurementData & aGpsTimingData

GetMeasurementData(TUint, TPositionGpsMeasurementData &)

IMPORT_C TInt	GetMeasurementData	(	TUint	aIndex,
			TPositionGpsMeasurementData &	aMeasurementData
		)	const

Gets measurement data by index into TPositionGpsMeasurementInfo NumMeasurements AppendMeasurementData

Parameters

TUint aIndex	The index of the measurement data requested. An index of zero specifies the first set of measurement data
TPositionGpsMeasurementData & aMeasurementData	Holds the returned measurement data

GpsTimeOfWeek()

IMPORT_C TInt

GpsTimeOfWeek

(

)

const

Returns the GPS Time of Week in milliseconds

Note that RRC and RRLP encode this using a different algorithm in their respective GPS Measurement Position Response message elements.

For RRC the actual value in milliseconds is sent, in the range 0 to 604800000.

For RRLP the value sent is a 24 bit representation of actual GPS TOW in ms in the range 0 to 14399999. This value should be set to ( GpsTimeOfWeek() mod 14400000), ie the remainder of division by 14400000.

SetGpsTimeOfWeek

NumMeasurements()

IMPORT_C TInt

NumMeasurements

(

)

const

The number of measurements held GetMeasurementData

PositionCalculationPossible()

IMPORT_C TBool

PositionCalculationPossible

(

)

const

Returns true if the measurement info is complete enough so it should be possible to calculate a position.

SetGpsTimeOfWeek(TInt)

IMPORT_C void

SetGpsTimeOfWeek

(

TInt

aGpsTimeOfWeek

)

Sets the GPS Time of Week

The Time of Week in milliseconds, with no conversion specific to the location protocol in use (RRC, RRLP or other).

GpsTimeOfWeek

Parameters

TInt aGpsTimeOfWeek

The GPS Time of Week to assign

SetGpsTimingData(const TGpsTimingMeasurementData &)

IMPORT_C void

SetGpsTimingData

(

const TGpsTimingMeasurementData &

aGpsTimingData

)

Sets the GPS Timing Measurement Data

Parameters

const TGpsTimingMeasurementData & aGpsTimingData

the populated GPS Timing Measurement Data to be set

SetPositionCalculationPossible(TBool)

IMPORT_C void

SetPositionCalculationPossible

(

TBool

aCalcPossible

)

The indicator is typically set by an AGPS positioning module and, if set to true, instructs the Location subsystem to complete Terminal Assisted positioning without waiting for a positioning timeout to expire.