Collapse all Symbian^3 Application Developer Library

TSatelliteData Class Reference

class TSatelliteData

This class is used to transfer data about a satellite

Public Member Functions
	TSatelliteData ()
IMPORT_C TReal32	Azimuth ()
IMPORT_C TReal32	Elevation ()
IMPORT_C TBool	IsUsed ()
IMPORT_C TInt	SatelliteId ()
IMPORT_C void	SetAzimuth ( TReal32 )
IMPORT_C void	SetElevation ( TReal32 )
IMPORT_C void	SetIsUsed ( TBool )
IMPORT_C void	SetSatelliteId ( TInt )
IMPORT_C void	SetSignalStrength ( TInt )
IMPORT_C TInt	SignalStrength ()

Protected Attributes
TReal32	iAzimuth
TReal32	iElevation
TBool	iIsUsed
TInt	iSatelliteId
TInt	iSignalStrength

Private Attributes
TUint8	iReserved

Constructor & Destructor Documentation

TSatelliteData()

IMPORT_C

TSatelliteData

(

)

Default constructor for a TSatelliteData . Note the azimuth and elevation are both initially NaN.

Member Functions Documentation

Azimuth()

IMPORT_C TReal32

Azimuth

(

)

const

Returns the satellite azimuth

Elevation()

IMPORT_C TReal32

Elevation

(

)

const

Returns the satellite elevation

IsUsed()

IMPORT_C TBool

IsUsed

(

)

const

Returns Whether this satellite is used

SatelliteId()

IMPORT_C TInt

SatelliteId

(

)

const

The satellite ID

SetAzimuth(TReal32)

IMPORT_C void

SetAzimuth

(

TReal32

aAzimuth

)

Sets the satellite azimuth

Parameters

TReal32 aAzimuth

The satellite azimuth to be set

SetElevation(TReal32)

IMPORT_C void

SetElevation

(

TReal32

aElevation

)

Sets the satellite elevation to be set

Parameters

TReal32 aElevation

The satellite elevation to be set

SetIsUsed(TBool)

IMPORT_C void

SetIsUsed

(

TBool

aIsUsed

)

sets whether this satellite will be used

Parameters

TBool aIsUsed

Whether this satellite will be used

SetSatelliteId(TInt)

IMPORT_C void

SetSatelliteId

(

TInt

aSatelliteId

)

The satellite ID to be set

Parameters

TInt aSatelliteId

The satellite ID to be set

SetSignalStrength(TInt)

IMPORT_C void

SetSignalStrength

(

TInt

aSignalStrength

)

Sets the signal strength

Parameters

TInt aSignalStrength

The signal strength to set

SignalStrength()

IMPORT_C TInt

SignalStrength

(

)

const

Returns the signal strength

Member Data Documentation

TReal32 iAzimuth

TReal32

iAzimuth

[protected]

The azimuth, in degrees

TReal32 iElevation

TReal32

iElevation

[protected]

The elevation, in degrees

TBool iIsUsed

TBool

iIsUsed

[protected]

Whether the satellite is used

TUint8 iReserved

TUint8

iReserved

[private]

Unused variable for future expansion.

TInt iSatelliteId

TInt

iSatelliteId

[protected]

The ID (in GPS, the PRN)

TInt iSignalStrength

TInt

iSignalStrength

[protected]

The signal strength, in decibels