TPositionSatelliteInfo Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

None

Exceptions

The capability Location is required in:

TInt RPositionServer::GetDefaultModuleId(TPositionModuleId& aModuleId) const;

TInt RPositionServer::GetNumModules(TUint& aNumModules) const;

TInt RPositionServer::GetModuleInfoByIndex(TInt aModuleIndex, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleInfoById(TPositionModuleId aModuleId, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleStatus(TPositionModuleStatusBase& aPosModuleStatus, TPositionModuleId aModuleId) const;

void RPositionServer::NotifyModuleStatusEvent(TPositionModuleStatusEventBase& aStatusEvent,TRequestStatus& aStatus,const TPositionModuleId aModuleId = KPositionNullModuleId) const;

TInt RPositioner::SetRequestor(CRequestor::TRequestorType aType,CRequestor::TRequestorFormat aFormat,const TDesC& aData);

TInt RPositioner::SetRequestor(const RRequestorStack& aRequestorStack);

TInt RPositioner::SetUpdateOptions(const TPositionUpdateOptionsBase& aPosOption);

TInt RPositioner::GetUpdateOptions(TPositionUpdateOptionsBase& aPosOption) const;

void RPositioner::GetLastKnownPosition(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

void RPositioner::NotifyPositionUpdate(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

#include <lbssatellite.h>

Inherits TPositionCourseInfo.

Detailed Description

This class is used to store information about positions obtained by satellites.

Public Member Functions
IMPORT_C  TPositionSatelliteInfo ()
  TPositionSatelliteInfo constructor.
IMPORT_C TInt  GetSatelliteData (TUint aIndex, TSatelliteData &aSatelliteData) const
  Get the data of a particular satellite used for positioning.
IMPORT_C TInt  AppendSatelliteData (const TSatelliteData &aSatelliteData)
  This method is not intended for the client's usage.
IMPORT_C TInt  NumSatellitesInView () const
  Get the information about the number of satellites that are available for position determination.
IMPORT_C void  ClearSatellitesInView ()
  Reset the number of satellites in view.
IMPORT_C TInt  NumSatellitesUsed () const
  Get the information about the number of satellites that are being used for position determination.
IMPORT_C TTime  SatelliteTime () const
  Get the time as per the satellite.
IMPORT_C void  SetSatelliteTime (TTime aTime)
  This method is not intended for the client's usage.
IMPORT_C TReal32  HorizontalDoP () const
  Get the horizontal dilution of precision.
IMPORT_C TReal32  VerticalDoP () const
  Get the vertical dilution of precision.
IMPORT_C TReal32  TimeDoP () const
  Get the time dilution of precision.
IMPORT_C void  SetHorizontalDoP (TReal32 aDoPValue)
  This method is not intended for the client's usage.
IMPORT_C void  SetVerticalDoP (TReal32 aDoPValue)
  This method is not intended for the client's usage.
IMPORT_C void  SetTimeDoP (TReal32 aDoPValue)
  This method is not intended for the client's usage.

Protected Attributes
TUint  iNumSatellitesInView
  The number of satellites in view.
TUint  iNumSatellitesUsed
  The number of satellites used.
TTime  iSatelliteTime
  The time according to the satellite.
TReal32  iHorizontalDoPValue
  The horizontal dilution of precision.
TReal32  iVerticalDoPValue
  The vertical dilution of precision.
TReal32  iTimeDoPValue
  The time dilution of precision.
TFixedArray< TSatelliteData,
KPositionMaxSatellitesInView >  		iSatellitesInView
  The satellites in view.

Constructor & Destructor Documentation

IMPORT_C TPositionSatelliteInfo::TPositionSatelliteInfo (   ) 
 

TPositionSatelliteInfo constructor.

Member Function Documentation

IMPORT_C TInt TPositionSatelliteInfo::AppendSatelliteData (  const TSatelliteData &  aSatelliteData  ) 
 

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

Append the data of a particular satellite used for positioning. This method is usually used by the positioning module to set the satellite information.

Parameters:
[in]  aSatelliteData  The data to append
Returns:
a symbian OS error code

KErrNone if successful

KErrOverflow otherwise

IMPORT_C void TPositionSatelliteInfo::ClearSatellitesInView (   ) 
 

Reset the number of satellites in view.

IMPORT_C TInt TPositionSatelliteInfo::GetSatelliteData (  TUint  aIndex,
TSatelliteData &  aSatelliteData
)  const
 

Get the data of a particular satellite used for positioning.

Parameters:
aIndex  The index of the satellite whose data is requested
[out]  aSatelliteData  The TSatelliteData structure where the data will be placed
Returns:
a symbian OS error code

KErrNone if successful

KErrNotFound otherwise

IMPORT_C TReal32 TPositionSatelliteInfo::HorizontalDoP (   )  const
 

Get the horizontal dilution of precision.

Dilution of precision indicates the accuracy of the measured value.

Returns:
The horizontal dilution of precision
Note:
the horizontal dilution of precision value is initially NaN.
IMPORT_C TInt TPositionSatelliteInfo::NumSatellitesInView (   )  const
 

Get the information about the number of satellites that are available for position determination.

Returns:
The number of satellites in view
IMPORT_C TInt TPositionSatelliteInfo::NumSatellitesUsed (   )  const
 

Get the information about the number of satellites that are being used for position determination.

Returns:
The number of satellites used in the calculation
IMPORT_C TTime TPositionSatelliteInfo::SatelliteTime (   )  const
 

Get the time as per the satellite.

Returns:
The time according to the satellite
IMPORT_C void TPositionSatelliteInfo::SetHorizontalDoP (  TReal32  aDoPValue  ) 
 

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

The positioning module uses this method to set the horizontal dilution of precision.

Parameters:
aDoPValue  The horizontal dilution of precision to be set
IMPORT_C void TPositionSatelliteInfo::SetSatelliteTime (  TTime  aTime  ) 
 

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

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

Parameters:
aTime  The satellite time to be set
IMPORT_C void TPositionSatelliteInfo::SetTimeDoP (  TReal32  aDoPValue  ) 
 

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

The positioning module uses this method to set the time dilution of precision.

Parameters:
aDoPValue  The time dilution of precision to be set
IMPORT_C void TPositionSatelliteInfo::SetVerticalDoP (  TReal32  aDoPValue  ) 
 

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

The positioning module uses this method to set the vertical dilution of precision.

Parameters:
aDoPValue  The vertical dilution of precision to be set
IMPORT_C TReal32 TPositionSatelliteInfo::TimeDoP (   )  const
 

Get the time dilution of precision.

Dilution of precision indicates the accuracy of the measured value.

Returns:
The time dilution of precision
Note:
the time dilution of precision value is initially NaN.
IMPORT_C TReal32 TPositionSatelliteInfo::VerticalDoP (   )  const
 

Get the vertical dilution of precision.

Dilution of precision indicates the accuracy of the measured value.

Returns:
The vertical dilution of precision
Note:
the vertical dilution of precision value is initially NaN.

Field Documentation

TReal32 TPositionSatelliteInfo::iHorizontalDoPValue [protected]
 

The horizontal dilution of precision.

TUint TPositionSatelliteInfo::iNumSatellitesInView [protected]
 

The number of satellites in view.

TUint TPositionSatelliteInfo::iNumSatellitesUsed [protected]
 

The number of satellites used.

TFixedArray<TSatelliteData, KPositionMaxSatellitesInView> TPositionSatelliteInfo::iSatellitesInView [protected]
 

The satellites in view.

TTime TPositionSatelliteInfo::iSatelliteTime [protected]
 

The time according to the satellite.

TReal32 TPositionSatelliteInfo::iTimeDoPValue [protected]
 

The time dilution of precision.

TReal32 TPositionSatelliteInfo::iVerticalDoPValue [protected]
 

The vertical dilution of precision.

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