Collapse all Symbian^3 Product Developer Library

TPositionQuality Class Reference

class TPositionQuality : public TPositionQualityBase

The standard position quality class.

Inherits from

TPositionQuality
- TPositionQualityBase
  - TPositionClassTypeBase

Public Member Functions
	TPositionQuality()
IMPORT_C TCostIndicator	CostIndicator()
IMPORT_C TReal32	HorizontalAccuracy()
IMPORT_C TPowerConsumption	PowerConsumption()
IMPORT_C void	SetCostIndicator(TCostIndicator)
IMPORT_C void	SetHorizontalAccuracy(TReal32)
IMPORT_C void	SetPowerConsumption(TPowerConsumption)
IMPORT_C void	SetTimeToFirstFix(TTimeIntervalMicroSeconds)
IMPORT_C void	SetTimeToNextFix(TTimeIntervalMicroSeconds)
IMPORT_C void	SetVerticalAccuracy(TReal32)
IMPORT_C TTimeIntervalMicroSeconds	TimeToFirstFix()
IMPORT_C TTimeIntervalMicroSeconds	TimeToNextFix()
IMPORT_C TReal32	VerticalAccuracy()

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()

Public Member Enumerations
enum	TCostIndicator { ECostUnknown, ECostZero, ECostPossible, ECostCharge }
enum	TPowerConsumption { EPowerUnknown, EPowerZero, EPowerLow, EPowerMedium, EPowerHigh }

Private Attributes
TUint8	iReserved

Inherited Attributes
	TPositionClassTypeBase::iPosClassSize
	TPositionClassTypeBase::iPosClassType

Constructor & Destructor Documentation

TPositionQuality()

IMPORT_C

TPositionQuality

(

)

Default constructor for TPositionQuality

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

Member Functions Documentation

CostIndicator()

IMPORT_C TCostIndicator

CostIndicator

(

)

const

The cost indicator

HorizontalAccuracy()

IMPORT_C TReal32

HorizontalAccuracy

(

)

const

Horizontal Accuracy

PowerConsumption()

IMPORT_C TPowerConsumption

PowerConsumption

(

)

const

The power consumption

SetCostIndicator(TCostIndicator)

IMPORT_C void

SetCostIndicator

(

TCostIndicator

aCost

)

The cost indicator to set

Parameters

TCostIndicator aCost

The cost indicator to set

SetHorizontalAccuracy(TReal32)

IMPORT_C void

SetHorizontalAccuracy

(

TReal32

aHorizontalAccuracy

)

Sets horizontal accuracy

panic: "LocationClient EPositionBadAccuracy" if aHorizontalAccuracy is negative.

Parameters

TReal32 aHorizontalAccuracy

The horizontal accuracy to set

SetPowerConsumption(TPowerConsumption)

IMPORT_C void

SetPowerConsumption

(

TPowerConsumption

aPower

)

The power consumption to set

Parameters

TPowerConsumption aPower

The power consumption to set

SetTimeToFirstFix(TTimeIntervalMicroSeconds)

IMPORT_C void

SetTimeToFirstFix

(

TTimeIntervalMicroSeconds

aTimeToFirstFix

)

Sets time to first fix

panic: "LocationClient EPositionBadTime" if aTimeToFirstFix is negative.

Parameters

TTimeIntervalMicroSeconds aTimeToFirstFix

The time required to obtain an initial location fix to set

SetTimeToNextFix(TTimeIntervalMicroSeconds)

IMPORT_C void

SetTimeToNextFix

(

TTimeIntervalMicroSeconds

aTimeToNextFix

)

Sets time to next fix

panic: "LocationClient EPositionBadTime" if aTimeToNextFix is negative.

Parameters

TTimeIntervalMicroSeconds aTimeToNextFix

The time required to obtain subsequent location fixes to set

SetVerticalAccuracy(TReal32)

IMPORT_C void

SetVerticalAccuracy

(

TReal32

aVerticalAccuracy

)

Sets vertical accuracy

panic: "LocationClient EPositionBadAccuracy" if aVerticalAccuracy is negative.

Parameters

TReal32 aVerticalAccuracy

The vertical accuracy to set

TimeToFirstFix()

IMPORT_C TTimeIntervalMicroSeconds

TimeToFirstFix

(

)

const

The time required to obtain an initial location fix

TimeToNextFix()

IMPORT_C TTimeIntervalMicroSeconds

TimeToNextFix

(

)

const

The time required to obtain subsequent location fixes

VerticalAccuracy()

IMPORT_C TReal32

VerticalAccuracy

(

)

const

The vertical accuracy

Member Enumerations Documentation

Enum TCostIndicator

Cost Indicator for position request

Enumerators

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

Enumerators

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

Member Data Documentation

TUint8 iReserved

TUint8

iReserved

[private]

Unused variable for future expansion.