Class TPositionQuality

class TPositionQuality : public TPositionQualityBase;

Description

The standard position quality class.

Derivation

• TPositionClassTypeBase - The base class for classes used to store position information

• TPositionQualityBase - The base class for classes used to store position quality information

• TPositionQuality - The standard position quality class

Members

Defined in TPositionQuality:
CostIndicator(), ECostCharge, ECostPossible, ECostUnknown, ECostZero, EPowerHigh, EPowerLow, EPowerMedium, EPowerUnknown, EPowerZero, HorizontalAccuracy(), PowerConsumption(), SetCostIndicator(), SetHorizontalAccuracy(), SetPowerConsumption(), SetTimeToFirstFix(), SetTimeToNextFix(), SetVerticalAccuracy(), TCostIndicator, TPositionQuality(), TPowerConsumption, TimeToFirstFix(), TimeToNextFix(), VerticalAccuracy()

Inherited from TPositionClassTypeBase:
PositionClassSize(), PositionClassType(), iPosClassSize, iPosClassType

Inherited from TPositionQualityBase:
Compare(), GetElement(), HighWaterMark(), IsDefined(), ResetElement(), SetElement()

IMPORT_C TPositionQuality();

Description

Default constructor for TPositionQuality

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

IMPORT_C TTimeIntervalMicroSeconds TimeToFirstFix() const;

Description

The time required to obtain an initial location fix

Return value

TTimeIntervalMicroSeconds The time required to obtain an initial location fix

IMPORT_C TTimeIntervalMicroSeconds TimeToNextFix() const;

Description

The time required to obtain subsequent location fixes

Return value

TTimeIntervalMicroSeconds The time required to obtain subsequent location fixes

IMPORT_C TReal32 HorizontalAccuracy() const;

Description

Horizontal Accuracy

Return value

TReal32 The horizontal accuracy

IMPORT_C TReal32 VerticalAccuracy() const;

Description

The vertical accuracy

Return value

TReal32 The vertical accuracy

IMPORT_C TCostIndicator CostIndicator() const;

Description

The cost indicator

Return value

TCostIndicator The cost indicator

IMPORT_C TPowerConsumption PowerConsumption() const;

Description

The power consumption

Return value

TPowerConsumption The power consumption

IMPORT_C void SetTimeToFirstFix(TTimeIntervalMicroSeconds aTimeToFirstFix);

Description

Sets time to first fix

Parameters

TTimeIntervalMicroSeconds aTimeToFirstFix The time required to obtain an initial location fix to set

Panic codes

EPositionBadTime If aTimeToFirstFix is negative

IMPORT_C void SetTimeToNextFix(TTimeIntervalMicroSeconds aTimeToNextFix);

Description

Sets time to next fix

Parameters

TTimeIntervalMicroSeconds aTimeToNextFix The time required to obtain subsequent location fixes to set

Panic codes

EPositionBadTime If aTimeToNextFix is negative

IMPORT_C void SetHorizontalAccuracy(TReal32 aHorizontalAccuracy);

Description

Sets horizontal accuracy

Parameters

TReal32 aHorizontalAccuracy The horizontal accuracy to set

Panic codes

EPositionBadAccuracy If aHorizontalAccuracy is negative

IMPORT_C void SetVerticalAccuracy(TReal32 aVerticalAccuracy);

Description

Sets vertical accuracy

Parameters

TReal32 aVerticalAccuracy The vertical accuracy to set

Panic codes

EPositionBadAccuracy If aVerticalAccuracy is negative

IMPORT_C void SetCostIndicator(TCostIndicator aCost);

Description

The cost indicator to set

Parameters

TCostIndicator aCost The cost indicator to set

IMPORT_C void SetPowerConsumption(TPowerConsumption aPower);

Description

The power consumption to set

Parameters

TPowerConsumption aPower The power consumption to set

TCostIndicator

Description

Cost Indicator for position request

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

TPowerConsumption

Description

Power consumption

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