#include <LbsCommon.h>
Link against: lbs.lib
Link against: lbsselflocate.lib

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()constThe cost indicator
ECostChargeCharged The positioning module expects a charge to be levied when obtaining posi...
ECostPossiblePossible cost The positioning module is uncertain if the user will incur a charg...
ECostUnknownUnknown cost This is the unassigned value and should not be returned
ECostZeroZero cost No cost is expected to be incurred when obtaining a position fix
EPowerHighHigh power consumption The positioning module expects a high power drain when us...
EPowerLowLow power consumption The positioning module expects a minimum power drain when ...
EPowerMediumMedium power consumption The positioning module expects a moderate power drain w...
EPowerUnknownUnknown power consumption The positioning module is unable to determine the like...
EPowerZeroZero power consumption No internal power will be used when obtaining a position ...
HorizontalAccuracy()constHorizontal Accuracy
PowerConsumption()constThe power consumption
SetCostIndicator(TCostIndicator)The cost indicator to set
SetHorizontalAccuracy(TReal32)Sets horizontal accuracy
SetPowerConsumption(TPowerConsumption)The power consumption to set
SetTimeToFirstFix(TTimeIntervalMicroSeconds)Sets time to first fix
SetTimeToNextFix(TTimeIntervalMicroSeconds)Sets time to next fix
SetVerticalAccuracy(TReal32)Sets vertical accuracy
TCostIndicatorCost Indicator for position request
TPositionQuality()Default constructor for TPositionQuality
TPowerConsumptionPower consumption
TimeToFirstFix()constThe time required to obtain an initial location fix
TimeToNextFix()constThe time required to obtain subsequent location fixes
VerticalAccuracy()constThe vertical accuracy

Inherited from TPositionClassTypeBase:

PositionClassSize()constPositionClassSize
PositionClassType()constPositionClassTypeType
iPosClassSizeThe size of the derived class
iPosClassTypeThe type of the derived class

Inherited from TPositionQualityBase:

HighWaterMark()constReturns The High Water Mark
IsDefined(TInt)constReturns whether an element is defined
ResetElement(TInt)Resets element

Construction and destruction

`TPositionQuality()`

IMPORT_C TPositionQuality();

Description

Default constructor for TPositionQuality

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

Member functions

`TimeToFirstFix()const`

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

`TimeToNextFix()const`

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

`HorizontalAccuracy()const`

IMPORT_C TReal32 HorizontalAccuracy() const;

Description

Horizontal Accuracy

Return value

TReal32

The horizontal accuracy

`VerticalAccuracy()const`

IMPORT_C TReal32 VerticalAccuracy() const;

Description

The vertical accuracy

Return value

TReal32

The vertical accuracy

`CostIndicator()const`

IMPORT_C TCostIndicator CostIndicator() const;

Description

The cost indicator

Return value

TPositionQuality::TCostIndicator

The cost indicator

`PowerConsumption()const`

IMPORT_C TPowerConsumption PowerConsumption() const;

Description

The power consumption

Return value

TPositionQuality::TPowerConsumption

The power consumption

`SetTimeToFirstFix(TTimeIntervalMicroSeconds)`

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

"LocationClient

EPositionBadTime" if aTimeToFirstFix is negative.

`SetTimeToNextFix(TTimeIntervalMicroSeconds)`

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

"LocationClient

EPositionBadTime" if aTimeToNextFix is negative.

`SetHorizontalAccuracy(TReal32)`

IMPORT_C void SetHorizontalAccuracy(TReal32 aHorizontalAccuracy);

Description

Sets horizontal accuracy

Parameters


                                 						TReal32 aHorizontalAccuracy

The horizontal accuracy to set

Panic codes

"LocationClient

EPositionBadAccuracy" if aHorizontalAccuracy is negative.

`SetVerticalAccuracy(TReal32)`

IMPORT_C void SetVerticalAccuracy(TReal32 aVerticalAccuracy);

Description

Sets vertical accuracy

Parameters


                                 						TReal32 aVerticalAccuracy

The vertical accuracy to set

Panic codes

"LocationClient

EPositionBadAccuracy" if aVerticalAccuracy is negative.

`SetCostIndicator(TCostIndicator)`

IMPORT_C void SetCostIndicator(TCostIndicator aCost);

Description

The cost indicator to set

Parameters


                                 						TPositionQuality::TCostIndicator aCost

The cost indicator to set

`SetPowerConsumption(TPowerConsumption)`

IMPORT_C void SetPowerConsumption(TPowerConsumption aPower);

Description

The power consumption to set

Parameters


                                 						TPositionQuality::TPowerConsumption aPower

The power consumption to set

Member enumerations

Enum `TCostIndicator`

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

Enum `TPowerConsumption`

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

Class TPositionQuality

Description

Derivation

Members

Construction and destruction

TPositionQuality()

Description

Member functions

TimeToFirstFix()const

Description

Return value

TimeToNextFix()const

Description

Return value

HorizontalAccuracy()const

Description

Return value

VerticalAccuracy()const

Description

Return value

CostIndicator()const

Description

Return value

PowerConsumption()const

Description

Return value

SetTimeToFirstFix(TTimeIntervalMicroSeconds)

Description

Parameters

Panic codes

SetTimeToNextFix(TTimeIntervalMicroSeconds)

Description

Parameters

Panic codes

SetHorizontalAccuracy(TReal32)

Description

Parameters

Panic codes

SetVerticalAccuracy(TReal32)

Description

Parameters

Panic codes

SetCostIndicator(TCostIndicator)

Description

Parameters

SetPowerConsumption(TPowerConsumption)

Description

Parameters

Member enumerations

Enum TCostIndicator

Description

Enum TPowerConsumption

Description

Class `TPositionQuality`

`TPositionQuality()`

`TimeToFirstFix()const`

`TimeToNextFix()const`

`HorizontalAccuracy()const`

`VerticalAccuracy()const`

`CostIndicator()const`

`PowerConsumption()const`

`SetTimeToFirstFix(TTimeIntervalMicroSeconds)`

`SetTimeToNextFix(TTimeIntervalMicroSeconds)`

`SetHorizontalAccuracy(TReal32)`

`SetVerticalAccuracy(TReal32)`

`SetCostIndicator(TCostIndicator)`

`SetPowerConsumption(TPowerConsumption)`

Enum `TCostIndicator`

Enum `TPowerConsumption`