TPositionQuality Class Reference
| class TPositionQuality : public 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
| 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 ( )
Returns: The cost indicator
HorizontalAccuracy ( )
| IMPORT_C TReal32 | HorizontalAccuracy | ( | ) | const |
Returns: The horizontal accuracy
PowerConsumption ( )
Returns: The power consumption
SetCostIndicator ( TCostIndicator )
The cost indicator to set
| Parameter | Description | | aCost | The cost indicator to set |
SetHorizontalAccuracy ( TReal32 )
| IMPORT_C void | SetHorizontalAccuracy | ( | TReal32 | aHorizontalAccuracy | ) | |
Sets horizontal accuracy
- panic
- "LocationClient EPositionBadAccuracy" if aHorizontalAccuracy is negative.
| Parameter | Description | | aHorizontalAccuracy | The horizontal accuracy to set |
SetPowerConsumption ( TPowerConsumption )
The power consumption to set
| Parameter | Description | | aPower | The power consumption to set |
SetTimeToFirstFix ( TTimeIntervalMicroSeconds )
Sets time to first fix
- panic
- "LocationClient EPositionBadTime" if aTimeToFirstFix is negative.
| Parameter | Description | | aTimeToFirstFix | The time required to obtain an initial location fix to set |
SetTimeToNextFix ( TTimeIntervalMicroSeconds )
Sets time to next fix
- panic
- "LocationClient EPositionBadTime" if aTimeToNextFix is negative.
| Parameter | Description | | 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.
| Parameter | Description | | aVerticalAccuracy | The vertical accuracy to set |
TimeToFirstFix ( )
The time required to obtain an initial location fix
Returns: The time required to obtain an initial location fix
TimeToNextFix ( )
The time required to obtain subsequent location fixes
Returns: The time required to obtain subsequent location fixes
VerticalAccuracy ( )
| IMPORT_C TReal32 | VerticalAccuracy | ( | ) | const |
Returns: The vertical accuracy