TPositionQuality Class Reference

#include <lbscommon.h>

Link against: lbs.lib

class TPositionQuality : public TPositionQualityBase, public TPositionQualityBase

Inherits from

TPositionQuality
- TPositionQualityBase
  - TPositionClassTypeBase
  - TPositionClassTypeBase
- TPositionQualityBase
  - TPositionClassTypeBase
  - TPositionClassTypeBase

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

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

Enumerator	Value	Description
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

Enumerator	Value	Description
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_C

TPositionQuality

(

)

Default constructor for TPositionQuality

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

Member Function Documentation

CostIndicator ( )

IMPORT_C TCostIndicator

CostIndicator

(

)

const

The cost indicator

Return Value: The cost indicator

HorizontalAccuracy ( )

IMPORT_C TReal32

HorizontalAccuracy

(

)

const

Horizontal Accuracy

Return Value: The horizontal accuracy

PowerConsumption ( )

IMPORT_C TPowerConsumption

PowerConsumption

(

)

const

The power consumption

Return Value: The power consumption

SetCostIndicator ( TCostIndicator )

IMPORT_C void

SetCostIndicator

(

TCostIndicator

aCost

)

The cost indicator to set

Parameters
aCost	The cost indicator to set

SetHorizontalAccuracy ( TReal32 )

IMPORT_C void

SetHorizontalAccuracy

(

TReal32

aHorizontalAccuracy

)

Sets horizontal accuracy

Parameters
aHorizontalAccuracy	The horizontal accuracy to set

Panic Codes
"LocationClient	EPositionBadAccuracy" if aHorizontalAccuracy is negative.

SetPowerConsumption ( TPowerConsumption )

IMPORT_C void

SetPowerConsumption

(

TPowerConsumption

aPower

)

The power consumption to set

Parameters
aPower	The power consumption to set

SetTimeToFirstFix ( TTimeIntervalMicroSeconds )

IMPORT_C void

SetTimeToFirstFix

(

TTimeIntervalMicroSeconds

aTimeToFirstFix

)

Sets time to first fix

Parameters
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

)

Sets time to next fix

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

Panic Codes
"LocationClient	EPositionBadTime" if aTimeToNextFix is negative.

SetVerticalAccuracy ( TReal32 )

IMPORT_C void

SetVerticalAccuracy

(

TReal32

aVerticalAccuracy

)

Sets vertical accuracy

Parameters
aVerticalAccuracy	The vertical accuracy to set

Panic Codes
"LocationClient	EPositionBadAccuracy" if aVerticalAccuracy is negative.

TimeToFirstFix ( )

IMPORT_C TTimeIntervalMicroSeconds

TimeToFirstFix

(

)

const

The time required to obtain an initial location fix

Return Value: The time required to obtain an initial location fix

TimeToNextFix ( )

IMPORT_C TTimeIntervalMicroSeconds

TimeToNextFix

(

)

const

The time required to obtain subsequent location fixes

Return Value: The time required to obtain subsequent location fixes

VerticalAccuracy ( )

IMPORT_C TReal32

VerticalAccuracy

(

)

const

The vertical accuracy

Return Value: The vertical accuracy