Collapse all Symbian^3 Application Developer Library

TOMASuplNavigationModel Class Reference

class TOMASuplNavigationModel

TOMASuplSatelliteInfoElement holds values for

GPS Week, which contains values for GPS Week of the Assistance Data currently held in the SET. The valid range is 0 to 1023.
GPS Toe, which contains the GPS time of Ephemeris in hours of the newest set of Ephemeris contained in the SUPL Enabled Terminal. Valid range is 0 to 167.
NSat, which contains the number of satellites to be considered for the current GPS Assistance data request. Valid range is 0 to 32.
Toe Limit, which contains the Ephemeris age tolerance of the SUPL Enabled Terminal in hours. Valid range is 0 to 10.
A list of Satellite Info objects. The number of satellite info elements held by the list is same as NSat. Each Satellite Info element contains the Satellite ID and Satellite Sequence Number.

Since: Series 60 3.1u

Public Member Functions
	TOMASuplNavigationModel ()
	~TOMASuplNavigationModel ()
IMPORT_C void	GetNavigationModel ( TInt &, TInt &, TInt &, TInt &)
IMPORT_C TInt	GetSatInfoElement ( RArray < TOMASuplSatelliteInfoElement > &)
IMPORT_C TInt	GetSatInfoElement ( TOMASuplSatelliteInfoElement &, TInt )
IMPORT_C TInt	SetNavigationModel ( TInt , TInt , TInt , TInt )
IMPORT_C void	SetSatInfoElement (const RArray < TOMASuplSatelliteInfoElement > &)
IMPORT_C TInt	SetSatInfoElement (const TOMASuplSatelliteInfoElement &, TInt )
TOMASuplNavigationModel &	operator= (const TOMASuplNavigationModel &)

Private Attributes
TInt	iGPSToe
TInt	iGPSWeek
TInt	iNSat
RArray < TOMASuplSatelliteInfoElement >	iSatInfo
TBool	iSatInfoPresent
TInt	iToeLimit

Constructor & Destructor Documentation

TOMASuplNavigationModel()

IMPORT_C

TOMASuplNavigationModel

(

)

~TOMASuplNavigationModel()

IMPORT_C

~TOMASuplNavigationModel

(

)

Member Functions Documentation

GetNavigationModel(TInt &, TInt &, TInt &, TInt &)

IMPORT_C void	GetNavigationModel	(	TInt &	aGpsWeek,
			TInt &	aGpsToe,
			TInt &	aNSAT,
			TInt &	aToeLimit
		)	const

GetNavigationModel retrieves values for the different parameters of Navigation Data.

Parameters

TInt & aGpsWeek	A reference parameter that holds the GPS Week of the assistance data currently held.
TInt & aGpsToe	A reference parameter that holds the GPS Time of Ephemeris in hours of the newest set of Ephemeris.
TInt & aNSAT	A reference parameter that holds Number of satellites to be considered for the current GPS assistance data request.
TInt & aToeLimit	A reference parameter that holds T-Toe Limit, that contains the age tolerance of the SET to the network in hours.

GetSatInfoElement(RArray< TOMASuplSatelliteInfoElement > &)

IMPORT_C TInt

GetSatInfoElement

(

RArray < TOMASuplSatelliteInfoElement > &

aSatInfo

)

const

GetSatInfoElement gets the set of all Satellite Info elements held by TOMASuplNavigationModel

Parameters

RArray < TOMASuplSatelliteInfoElement > & aSatInfo

A reference parameter that holds the Satellite Info Elements

GetSatInfoElement(TOMASuplSatelliteInfoElement &, TInt)

IMPORT_C TInt	GetSatInfoElement	(	TOMASuplSatelliteInfoElement &	aSatInfo,
			TInt	aIndex
		)	const

GetSatInfoElement gets Satellite Info element at a given index

Parameters

TOMASuplSatelliteInfoElement & aSatInfo	A reference parameter that holds the Satellite Info Element
TInt aIndex	The index for the Satellite Info Element to be retrieved

SetNavigationModel(TInt, TInt, TInt, TInt)

IMPORT_C TInt	SetNavigationModel	(	TInt	aGpsWeek,
			TInt	aGpsToe,
			TInt	aNSAT,
			TInt	aToeLimit
		)

SetNavigationModel sets values for the different parameters of Navigation Data

Parameters

TInt aGpsWeek	GPS Week of the assistance data currently held. Valid range is 0 to 1023
TInt aGpsToe	GPS Time of Ephemeris in hours of the newest set of Ephemeris. Valid range is 0 to 167
TInt aNSAT	Number of satellites to be considered for the current GPS assistance data request. Valid range is 0 to 31. If the SUPL Enabled Terminal has no ephemeris data, this field shall be set to zero. If the SUPL Enabled Terminal has ephemeris data whose age exceeds the T-Toe Limit, this field may be set to zero. If the network receives a zero value for this field, it ignores the GPS Week, GPS Toe fields and assumes that the SUPL Enabled Terminal has no ephemeris value
TInt aToeLimit	T-Toe Limit, that contains the age tolerance of the SET to the network in hours. Valid range is 0 to 10.

SetSatInfoElement(const RArray< TOMASuplSatelliteInfoElement > &)

IMPORT_C void

SetSatInfoElement

(

const RArray < TOMASuplSatelliteInfoElement > &

aSatInfo

)

SetSatInfoElement sets the Satellite Info Elements

Parameters

const RArray < TOMASuplSatelliteInfoElement > & aSatInfo

Parameter of type RArray, that has the Satellite Info elements

SetSatInfoElement(const TOMASuplSatelliteInfoElement &, TInt)

IMPORT_C TInt	SetSatInfoElement	(	const TOMASuplSatelliteInfoElement &	aSatInfo,
			TInt	aIndex
		)

SetSatInfoElement sets Satellite Info element at a given index

Parameters

const TOMASuplSatelliteInfoElement & aSatInfo	Parameter that holds the Satellite Info Element
TInt aIndex	The index at which the Satellite Info element has to be set