S60 3rd Edition API Reference: TPositionQuality Class Reference

TPositionQuality Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

Location

#include <lbscommon.h>

Inherits TPositionQualityBase.

Detailed Description

The standard position quality class.

Public Types

enum  TCostIndicator { ECostUnknown, ECostZero, ECostPossible, ECostCharge }
 Indicates if there is likely to be a charge when obtaining location information using the associated positioning module. More...
enum  TPowerConsumption {
  EPowerUnknown, EPowerZero, EPowerLow, EPowerMedium,
  EPowerHigh
}
 Indicates through a simple scale the likely power consumption associated with using a particular positioning module. More...

Public Member Functions

IMPORT_C TPositionQuality ()
 Default constructor for TPositionQuality Note that the horizontal accuracy and vertical accuracy are initially NaNs.
IMPORT_C TTimeIntervalMicroSeconds TimeToFirstFix () const
 Get the time taken for the first position fix.
IMPORT_C TTimeIntervalMicroSeconds TimeToNextFix () const
 Get the time taken for the subsequent position fixes.
IMPORT_C TReal32 HorizontalAccuracy () const
 Get the horizontal accuracy.
IMPORT_C TReal32 VerticalAccuracy () const
 Get the vertical accuracy.
IMPORT_C TCostIndicator CostIndicator () const
 This method indicates if there will be a monetary charge for obtaining a position fix.
IMPORT_C TPowerConsumption PowerConsumption () const
 This method indicates if there will be power consumption for obtaining a position fix.
IMPORT_C void SetTimeToFirstFix (TTimeIntervalMicroSeconds aTimeToFirstFix)
 Set the time required to obtain an initial location fix.
IMPORT_C void SetTimeToNextFix (TTimeIntervalMicroSeconds aTimeToNextFix)
 Set the time required to obtain subsequent location fixes after the first fix.
IMPORT_C void SetHorizontalAccuracy (TReal32 aHorizontalAccuracy)
 Set the Horizontal Accuracy.
IMPORT_C void SetVerticalAccuracy (TReal32 aVerticalAccuracy)
 Set the Vertical Accuracy.
IMPORT_C void SetCostIndicator (TCostIndicator aCost)
 Set if there will be a monetary charge when a position fix is obtained.
IMPORT_C void SetPowerConsumption (TPowerConsumption aPower)
 Set if there will be power consumption when a position fix is obtained.

Member Enumeration Documentation

enum TPositionQuality::TCostIndicator
 

Indicates if there is likely to be a charge when obtaining location information using the associated positioning module.

Enumerator:
ECostUnknown  This is an unassigned value and should not be returned.
ECostZero  This value indicates that no cost is expected to be incurred when obtaining a position fix.
ECostPossible  This value indicates that the positioning module is uncertain if the user will incur a charge when using the positioning module to obtain position information.
ECostCharge  This value indicates that the positioning module expects a charge to be levied when obtaining position information using the specific positioning module.
enum TPositionQuality::TPowerConsumption
 

Indicates through a simple scale the likely power consumption associated with using a particular positioning module.

Enumerator:
EPowerUnknown  This value indicates that the positioning module is unable to determine the likely power drain.
EPowerZero  This value indicates that no internal power will be used when obtaining position information.
EPowerLow  This value indicates that the positioning module expects a minimum power drain when using the associated technology.

This may be comparable to the power usage when the phone is in the Standby mode.

EPowerMedium  This value indicates that the positioning module expects a moderate power drain when using the associated technology.

This may be comparable to the power usage when the phone is being actively used.

EPowerHigh  This value indicates that the positioning module expects a high power drain when using the associated technology.

The use of this module will quickly consume the phone’s battery.

Constructor & Destructor Documentation

IMPORT_C TPositionQuality::TPositionQuality (   ) 
 

Default constructor for TPositionQuality Note that the horizontal accuracy and vertical accuracy are initially NaNs.

Member Function Documentation

IMPORT_C TCostIndicator TPositionQuality::CostIndicator (   )  const
 

This method indicates if there will be a monetary charge for obtaining a position fix.

Returns:
The cost indicator as an enumerated value of TCostIndicator
IMPORT_C TReal32 TPositionQuality::HorizontalAccuracy (   )  const
 

Get the horizontal accuracy.

Horizontal accuracy reflects the error for the latitude and longitude components of a position.

Returns:
The horizontal accuracy in metres
Note:
If no value is set, the default value is NaN. The client should check if the value is NaN through Math::IsNaN() before using the accuracy value.
IMPORT_C TPowerConsumption TPositionQuality::PowerConsumption (   )  const
 

This method indicates if there will be power consumption for obtaining a position fix.

It indicates the expected internal power usage.

Returns:
The power consumption as an enumerated value of TPowerConsumption
IMPORT_C void TPositionQuality::SetCostIndicator ( TCostIndicator  aCost  ) 
 

Set if there will be a monetary charge when a position fix is obtained.

Parameters:
aCost The cost indicator to set
IMPORT_C void TPositionQuality::SetHorizontalAccuracy ( TReal32  aHorizontalAccuracy  ) 
 

Set the Horizontal Accuracy.

Parameters:
aHorizontalAccuracy The horizontal accuracy to set
Panic:
"Lbs Client Fault" 13 if aHorizontalAccuracy parameter is negative.
IMPORT_C void TPositionQuality::SetPowerConsumption ( TPowerConsumption  aPower  ) 
 

Set if there will be power consumption when a position fix is obtained.

Parameters:
aPower The power consumption to set
IMPORT_C void TPositionQuality::SetTimeToFirstFix ( TTimeIntervalMicroSeconds  aTimeToFirstFix  ) 
 

Set the time required to obtain an initial location fix.

Parameters:
aTimeToFirstFix The time required to obtain an initial location fix
Panic:
"Lbs Client Fault" 12 if aTimeToFirstFix is negative.
IMPORT_C void TPositionQuality::SetTimeToNextFix ( TTimeIntervalMicroSeconds  aTimeToNextFix  ) 
 

Set the time required to obtain subsequent location fixes after the first fix.

Parameters:
aTimeToNextFix The time required to obtain subsequent location fixes
Panic:
"Lbs Client Fault" 12 if aTimeToNextFix is negative.
IMPORT_C void TPositionQuality::SetVerticalAccuracy ( TReal32  aVerticalAccuracy  ) 
 

Set the Vertical Accuracy.

Parameters:
aVerticalAccuracy The vertical accuracy to set
Panic:
"Lbs Client Fault" 13 if aVerticalAccuracy parameter is negative.
IMPORT_C TTimeIntervalMicroSeconds TPositionQuality::TimeToFirstFix (   )  const
 

Get the time taken for the first position fix.

Different positioning technologies can take a different amount of time to obtain the first position fix and subsequent fixes.

Returns:
The time required to obtain an initial location fix
IMPORT_C TTimeIntervalMicroSeconds TPositionQuality::TimeToNextFix (   )  const
 

Get the time taken for the subsequent position fixes.

Different positioning technologies can take a different amount of time to obtain the first position fix and subsequent fixes.

Returns:
The time required to obtain subsequent location fixes
IMPORT_C TReal32 TPositionQuality::VerticalAccuracy (   )  const
 

Get the vertical accuracy.

Vertical accuracy is the error in the altitude component. This method returns the vertical accuracy.

Returns:
The vertical accuracy in metres
Note:
If no value is set, the default value is NaN. The client should check if the value is NaN through Math::IsNaN() before using the accuracy value.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top