Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: LbsSatellite.h
Link against: lbsselflocate.lib

Class TSatelliteData

class TSatelliteData;

Description

This class is used to transfer data about a satellite

Members

Defined in TSatelliteData:
Azimuth(), Elevation(), IsUsed(), SatelliteId(), SetAzimuth(), SetElevation(), SetIsUsed(), SetSatelliteId(), SetSignalStrength(), SignalStrength(), TSatelliteData(), iAzimuth, iElevation, iIsUsed, iSatelliteId, iSignalStrength


Construction and destruction


TSatelliteData()

IMPORT_C TSatelliteData();

Description

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

[Top]


Member functions


SatelliteId()

IMPORT_C TInt SatelliteId() const;

Description

The satellite ID

Return value

TInt

The Satellite ID


SetSatelliteId()

IMPORT_C void SetSatelliteId(TInt aSatelliteId);

Description

The satellite ID to be set

Parameters

TInt aSatelliteId

The satellite ID to be set


Azimuth()

IMPORT_C TReal32 Azimuth() const;

Description

Returns the satellite azimuth

Return value

TReal32

The satellite azimuth


SetAzimuth()

IMPORT_C void SetAzimuth(TReal32 aAzimuth);

Description

Sets the satellite azimuth

Parameters

TReal32 aAzimuth

The satellite azimuth to be set


Elevation()

IMPORT_C TReal32 Elevation() const;

Description

Returns the satellite elevation

Return value

TReal32

The satellite elevation


SetElevation()

IMPORT_C void SetElevation(TReal32 aElevation);

Description

Sets the satellite elevation to be set

Parameters

TReal32 aElevation

The satellite elevation to be set


IsUsed()

IMPORT_C TBool IsUsed() const;

Description

Returns Whether this satellite is used

Return value

TBool

Whether this satellite is used


SetIsUsed()

IMPORT_C void SetIsUsed(TBool aIsUsed);

Description

sets whether this satellite will be used

Parameters

TBool aIsUsed

Whether this satellite will be used


SignalStrength()

IMPORT_C TInt SignalStrength() const;

Description

Returns the signal strength

Return value

TInt

The signal strength


SetSignalStrength()

IMPORT_C void SetSignalStrength(TInt aSignalStrength);

Description

Sets the signal strength

Parameters

TInt aSignalStrength

The signal strength to set

[Top]


Member data


iSatelliteId

protected: TInt iSatelliteId;

Description

The ID (in GPS, the PRN)


iAzimuth

protected: TReal32 iAzimuth;

Description

The azimuth, in degrees


iElevation

protected: TReal32 iElevation;

Description

The elevation, in degrees


iIsUsed

protected: TBool iIsUsed;

Description

Whether the satellite is used


iSignalStrength

protected: TInt iSignalStrength;

Description

The signal strength, in decibels