S60 3rd Edition API Reference: TSatelliteData Class Reference

TSatelliteData Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

Location

#include <lbssatellite.h>

Detailed Description

This class is used to transfer data about a satellite.

Public Member Functions

IMPORT_C TSatelliteData ()
 Default constructor for a TSatelliteData.
IMPORT_C TInt SatelliteId () const
IMPORT_C void SetSatelliteId (TInt aSatelliteId)
 This method is not intended for the client's usage.
IMPORT_C TReal32 Azimuth () const
 Get the azimuth value of the satellite.
IMPORT_C void SetAzimuth (TReal32 aAzimuth)
 This method is not intended for the client's usage.
IMPORT_C TReal32 Elevation () const
IMPORT_C void SetElevation (TReal32 aElevation)
 This method is not intended for the client's usage.
IMPORT_C TBool IsUsed () const
 Find if this satellite is being used to obtain position information.
IMPORT_C void SetIsUsed (TBool aIsUsed)
 This method is not intended for the client's usage.
IMPORT_C TInt SignalStrength () const
 Get the strength of the satellite signal.
IMPORT_C void SetSignalStrength (TInt aSignalStrength)
 This method is not intended for the client's usage.

Protected Attributes

TInt iSatelliteId
 The ID (in GPS, the PRN).
TReal32 iAzimuth
 The azimuth, in degrees.
TReal32 iElevation
 The elevation, in degrees.
TBool iIsUsed
 Whether the satellite is used.
TInt iSignalStrength
 The signal strength, in decibels.

Constructor & Destructor Documentation

IMPORT_C TSatelliteData::TSatelliteData (   ) 
 

Default constructor for a TSatelliteData.

Note the azimuth and elevation are both initially NaN.

Member Function Documentation

IMPORT_C TReal32 TSatelliteData::Azimuth (   )  const
 

Get the azimuth value of the satellite.

Note:
The azimuth can be NaN. The client should check if this field is NaN using Math::IsNaN() before doing any calculations based on this field.
Returns:
The satellite azimuth
IMPORT_C TReal32 TSatelliteData::Elevation (   )  const
 
Note:
The elevation can be NaN. The client should check if this field is NaN using Math::IsNaN() before doing any calculations based on this field.
Returns:
The satellite elevation
IMPORT_C TBool TSatelliteData::IsUsed (   )  const
 

Find if this satellite is being used to obtain position information.

Returns:
Whether this satellite is used
IMPORT_C TInt TSatelliteData::SatelliteId (   )  const
 
Returns:
The Satellite ID
IMPORT_C void TSatelliteData::SetAzimuth ( TReal32  aAzimuth  ) 
 

This method is not intended for the client's usage.

The positioning module uses this method to set the azimuth of this satellite.

Parameters:
aAzimuth The satellite azimuth to be set
IMPORT_C void TSatelliteData::SetElevation ( TReal32  aElevation  ) 
 

This method is not intended for the client's usage.

The positioning module uses this method to set the elevation of this satellite.

Parameters:
aElevation The satellite elevation to be set
IMPORT_C void TSatelliteData::SetIsUsed ( TBool  aIsUsed  ) 
 

This method is not intended for the client's usage.

The positioning module uses this method to set if this satellite is being used for position determination.

Parameters:
aIsUsed Whether this satellite will be used
IMPORT_C void TSatelliteData::SetSatelliteId ( TInt  aSatelliteId  ) 
 

This method is not intended for the client's usage.

The positioning module uses this method to set the Id of this satellite.

Parameters:
aSatelliteId The satellite ID to be set
IMPORT_C void TSatelliteData::SetSignalStrength ( TInt  aSignalStrength  ) 
 

This method is not intended for the client's usage.

The positioning module uses this method to set the strength of the signal from this satellite.

Parameters:
aSignalStrength The signal strength to set
IMPORT_C TInt TSatelliteData::SignalStrength (   )  const
 

Get the strength of the satellite signal.

Returns:
The signal strength

Field Documentation

TReal32 TSatelliteData::iAzimuth [protected]
 

The azimuth, in degrees.

TReal32 TSatelliteData::iElevation [protected]
 

The elevation, in degrees.

TBool TSatelliteData::iIsUsed [protected]
 

Whether the satellite is used.

TInt TSatelliteData::iSatelliteId [protected]
 

The ID (in GPS, the PRN).

TInt TSatelliteData::iSignalStrength [protected]
 

The signal strength, in decibels.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top