TSatelliteData Class Reference

#include <lbssatellite.h>

Link against: lbs.lib

class TSatelliteData

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

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()

Detailed Description

This class is used to transfer data about a satellite

Member Attribute Documentation

iAzimuth

TReal32

iAzimuth

[protected]

The azimuth, in degrees

iElevation

TReal32

iElevation

[protected]

The elevation, in degrees

iIsUsed

TBool

iIsUsed

[protected]

Whether the satellite is used

iSatelliteId

TInt

iSatelliteId

[protected]

The ID (in GPS, the PRN)

iSignalStrength

TInt

iSignalStrength

[protected]

The signal strength, in decibels

Constructor & Destructor Documentation

TSatelliteData ( )

IMPORT_C

TSatelliteData

(

)

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

Member Function Documentation

Azimuth ( )

IMPORT_C TReal32

Azimuth

(

)

const

Returns the satellite azimuth

Returns: The satellite azimuth

Elevation ( )

IMPORT_C TReal32

Elevation

(

)

const

Returns the satellite elevation

Returns: The satellite elevation

IsUsed ( )

IMPORT_C TBool

IsUsed

(

)

const

Returns Whether this satellite is used

Returns: Whether this satellite is used

SatelliteId ( )

IMPORT_C TInt

SatelliteId

(

)

const

The satellite ID

Returns: The Satellite ID

SetAzimuth ( TReal32 )

IMPORT_C void

SetAzimuth

(

TReal32

aAzimuth

)

Sets the satellite azimuth

Parameter	Description
aAzimuth	The satellite azimuth to be set

SetElevation ( TReal32 )

IMPORT_C void

SetElevation

(

TReal32

aElevation

)

Sets the satellite elevation to be set

Parameter	Description
aElevation	The satellite elevation to be set

SetIsUsed ( TBool )

IMPORT_C void

SetIsUsed

(

TBool

aIsUsed

)

sets whether this satellite will be used

Parameter	Description
aIsUsed	Whether this satellite will be used

SetSatelliteId ( TInt )

IMPORT_C void

SetSatelliteId

(

TInt

aSatelliteId

)

The satellite ID to be set

Parameter	Description
aSatelliteId	The satellite ID to be set

SetSignalStrength ( TInt )

IMPORT_C void

SetSignalStrength

(

TInt

aSignalStrength

)

Sets the signal strength

Parameter	Description
aSignalStrength	The signal strength to set

SignalStrength ( )

IMPORT_C TInt

SignalStrength

(

)

const

Returns the signal strength

Returns: The signal strength