#include <lbscriteria.h>
| class TPositionSelectionOrder |
| Protected Attributes | |
|---|---|
| SItem | iItems |
| TUint | iNumItems |
| Public Member Enumerations | |
|---|---|
| enum | TField { EFieldTimeToFirstFix, EFieldTimeToNextFix, EFieldHorizontalAccuracy, EFieldVerticalAccuracy, ..., EFieldLast } |
| enum | TOrder { EOrderDontCare, EOrderDefault, EOrderVeryLow, EOrderLow, ..., EOrderVeryHigh } |
| Public Member Functions | |
|---|---|
| TPositionSelectionOrder() | |
| IMPORT_C void | ClearSelectionOrder() |
| IMPORT_C TInt | GetSelectionItem(TUint, TField &, TOrder &) |
| IMPORT_C TUint | NumSelectionItems() |
| IMPORT_C void | ResetSelectionOrder() |
| IMPORT_C TInt | SetOrderCostIndicator(TOrder) |
| IMPORT_C TInt | SetOrderHorizontalAccuracy(TOrder) |
| IMPORT_C TInt | SetOrderPowerConsumption(TOrder) |
| IMPORT_C TInt | SetOrderTimeToFirstFix(TOrder) |
| IMPORT_C TInt | SetOrderTimeToNextFix(TOrder) |
| IMPORT_C TInt | SetOrderVerticalAccuracy(TOrder) |
| Protected Member Functions | |
|---|---|
| TInt | AddItem(TField, TOrder) |
This class is used as part of the TPositionCriteria class to chose a positioning module that will provide the desired quality of information. It allows position-quality-metrics to be given priorities, enabling them to be given preference in the decision.
Specifies the quality of position metrics that can be prioritized.
| Enumerator | Value | Description |
|---|---|---|
| EFieldTimeToFirstFix |
Time to first fix | |
| EFieldTimeToNextFix |
Time to next fix | |
| EFieldHorizontalAccuracy |
Field Horizontal Accuracy | |
| EFieldVerticalAccuracy |
Field Vertical Accuracy | |
| EFieldCost |
Field cost | |
| EFieldPower |
Field power | |
| EFieldNumFields |
Number of fields | |
| EFieldLast | KMaxTInt8 |
Last field |
| IMPORT_C | TPositionSelectionOrder | ( | ) |
Default constructor for TPositionSelectionOrder.
An internal method to add a selection criteria choice to the current set of criteria.
An internal method to add a selection criteria choice to the current set of criteria.
| Parameter | Description |
|---|---|
| aField | is a position quality metric, eg. horizontal accuracy |
| aOrder | is the priority for the given quality metric. |
Returns: a Symbian OS error code.
| IMPORT_C void | ClearSelectionOrder | ( | ) |
Clear all values including defaults. This is useful if the application wishes to specify its own priorities.
Not generally called by client applications. It retrieves a particular selection parameter.
| Parameter | Description |
|---|---|
| aIndex | the index of a selection parameter |
| aField | is set, upon successful completion, to the field ID at index aIndex. |
| aOrder | is set, upon successful completion, to the priority of the field at index aIndex. |
Returns: a Symbian OS error code.
| IMPORT_C TUint | NumSelectionItems | ( | ) | const |
Not generally called by client applications. It retrieves the number of selection parameters.
Returns: the number of selection items.
| IMPORT_C void | ResetSelectionOrder | ( | ) |
Used to restore the default selection ordering.