TPositionQuality Class Reference

#include <lbscommon.h>

Link against: lbs.lib

class TPositionQuality : public TPositionQualityBase, public TPositionQualityBase
Public Member Enumerations
enumTCostIndicator { ECostUnknown, ECostZero, ECostPossible, ECostCharge }
enumTPowerConsumption { EPowerUnknown, EPowerZero, EPowerLow, EPowerMedium, EPowerHigh }
Public Member Functions
TPositionQuality()
IMPORT_C TCostIndicatorCostIndicator()
IMPORT_C TReal32HorizontalAccuracy()
IMPORT_C TPowerConsumptionPowerConsumption()
IMPORT_C voidSetCostIndicator(TCostIndicator)
IMPORT_C voidSetHorizontalAccuracy(TReal32)
IMPORT_C voidSetPowerConsumption(TPowerConsumption)
IMPORT_C voidSetTimeToFirstFix(TTimeIntervalMicroSeconds)
IMPORT_C voidSetTimeToNextFix(TTimeIntervalMicroSeconds)
IMPORT_C voidSetVerticalAccuracy(TReal32)
IMPORT_C TTimeIntervalMicroSecondsTimeToFirstFix()
IMPORT_C TTimeIntervalMicroSecondsTimeToNextFix()
IMPORT_C TReal32VerticalAccuracy()
Inherited Attributes
TPositionClassTypeBase::iPosClassSize
TPositionClassTypeBase::iPosClassType
Inherited Functions
TPositionClassTypeBase::PositionClassSize()const
TPositionClassTypeBase::PositionClassType()const
TPositionClassTypeBase::TPositionClassTypeBase()
TPositionQualityBase::Compare(const TPositionQualityBase &,TInt,TPositionQualityItem::TResult &)const
TPositionQualityBase::GetElement(TInt,TPositionQualityItem::TDataType,T &)const
TPositionQualityBase::HighWaterMark()const
TPositionQualityBase::IsDefined(TInt)const
TPositionQualityBase::ResetElement(TInt)
TPositionQualityBase::SetElement(TInt,TPositionQualityItem::TDataType,TPositionQualityItem::TValuePreference,T)
TPositionQualityBase::TPositionQualityBase()

Detailed Description

The standard position quality class.

Member Enumeration Documentation

Enum TCostIndicator

Cost Indicator for position request

EnumeratorValueDescription
ECostUnknown

Unknown cost This is the unassigned value and should not be returned

ECostZero

Zero cost No cost is expected to be incurred when obtaining a position fix

ECostPossible

Possible cost The positioning module is uncertain if the user will incur a charge.

ECostCharge

Charged The positioning module expects a charge to be levied when obtaining position information

Enum TPowerConsumption

Power consumption

EnumeratorValueDescription
EPowerUnknown

Unknown power consumption The positioning module is unable to determine the likely power drain

EPowerZero

Zero power consumption No internal power will be used when obtaining a position fix

EPowerLow

Low power consumption 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 standby mode.

EPowerMedium

Medium power consumption 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

High power consumption The positioning module expects a high power drain when using the associated technology. Use of this module will quickly consume the phone's batteries

Constructor & Destructor Documentation

TPositionQuality ( )

IMPORT_CTPositionQuality()

Default constructor for TPositionQuality

Note that the horizontal accuracy and vertical accuracy are initially NaNs.

Member Function Documentation

CostIndicator ( )

IMPORT_C TCostIndicatorCostIndicator()const

The cost indicator

Return Value
The cost indicator

HorizontalAccuracy ( )

IMPORT_C TReal32HorizontalAccuracy()const

Horizontal Accuracy

Return Value
The horizontal accuracy

PowerConsumption ( )

IMPORT_C TPowerConsumptionPowerConsumption()const

The power consumption

Return Value
The power consumption

SetCostIndicator ( TCostIndicator )

IMPORT_C voidSetCostIndicator(TCostIndicatoraCost)

The cost indicator to set

Parameters
aCostThe cost indicator to set

SetHorizontalAccuracy ( TReal32 )

IMPORT_C voidSetHorizontalAccuracy(TReal32aHorizontalAccuracy)
Sets horizontal accuracy
Parameters
aHorizontalAccuracyThe horizontal accuracy to set
Panic Codes
"LocationClientEPositionBadAccuracy" if aHorizontalAccuracy is negative.

SetPowerConsumption ( TPowerConsumption )

IMPORT_C voidSetPowerConsumption(TPowerConsumptionaPower)

The power consumption to set

Parameters
aPowerThe power consumption to set

SetTimeToFirstFix ( TTimeIntervalMicroSeconds )

IMPORT_C voidSetTimeToFirstFix(TTimeIntervalMicroSecondsaTimeToFirstFix)
Sets time to first fix
Parameters
aTimeToFirstFixThe time required to obtain an initial location fix to set
Panic Codes
"LocationClientEPositionBadTime" if aTimeToFirstFix is negative.

SetTimeToNextFix ( TTimeIntervalMicroSeconds )

IMPORT_C voidSetTimeToNextFix(TTimeIntervalMicroSecondsaTimeToNextFix)
Sets time to next fix
Parameters
aTimeToNextFixThe time required to obtain subsequent location fixes to set
Panic Codes
"LocationClientEPositionBadTime" if aTimeToNextFix is negative.

SetVerticalAccuracy ( TReal32 )

IMPORT_C voidSetVerticalAccuracy(TReal32aVerticalAccuracy)
Sets vertical accuracy
Parameters
aVerticalAccuracyThe vertical accuracy to set
Panic Codes
"LocationClientEPositionBadAccuracy" if aVerticalAccuracy is negative.

TimeToFirstFix ( )

IMPORT_C TTimeIntervalMicroSecondsTimeToFirstFix()const

The time required to obtain an initial location fix

Return Value
The time required to obtain an initial location fix

TimeToNextFix ( )

IMPORT_C TTimeIntervalMicroSecondsTimeToNextFix()const

The time required to obtain subsequent location fixes

Return Value
The time required to obtain subsequent location fixes

VerticalAccuracy ( )

IMPORT_C TReal32VerticalAccuracy()const

The vertical accuracy

Return Value
The vertical accuracy