Class TPositionSelectionOrder

class TPositionSelectionOrder;

Description

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.

Members

Defined in TPositionSelectionOrder:

• ClearSelectionOrder()Clear all values including defaults. This is useful if the application wishes to...
• EFieldCostField cost
• EFieldHorizontalAccuracyField Horizontal Accuracy
• EFieldLastLast field
• EFieldNumFieldsNumber of fields
• EFieldPowerField power
• EFieldTimeToFirstFix Time to first fix
• EFieldTimeToNextFix Time to next fix
• EFieldVerticalAccuracyField Vertical Accuracy
• EOrderDefaultDefault
• EOrderDontCareDon't care
• EOrderFairlyHighFairly high
• EOrderFairlyLowFairly low
• EOrderHighHigh
• EOrderLowLow
• EOrderMediumMedium
• EOrderVeryHighVery high
• EOrderVeryLowVery low
• GetSelectionItem(TUint,TField &,TOrder &)constNot generally called by client applications. It retrieves a particular selection...
• NumSelectionItems()constNot generally called by client applications. It retrieves the number of selectio...
• ResetSelectionOrder()Used to restore the default selection ordering.
• SItemStores a field / priority pair.
• SetOrderCostIndicator(TOrder)Assigns a priority to the cost of a positioning technology when selecting a posi...
• SetOrderHorizontalAccuracy(TOrder)Assigns a priority to the horizontal accuracy when selecting a positioning modul...
• SetOrderPowerConsumption(TOrder)Assigns a priority to the power consumption of a positioning technology when sel...
• SetOrderTimeToFirstFix(TOrder)Assigns a priority to the time to first fix when selecting a positioning module.
• SetOrderTimeToNextFix(TOrder)Assigns a priority to the time to subsequent fixes when selecting a positioning ...
• SetOrderVerticalAccuracy(TOrder)Assigns a priority to the vertical accuracy when selecting a positioning module.
• TFieldSpecifies the quality of position metrics that can be prioritized.
• TOrderSpecifies the priority of selection parameters.
• TPositionSelectionOrder()Default constructor for TPositionSelectionOrder.
• iItemsArray of users position quality priorities.
• iNumItemsThe number of selection items in the iItems array.

IMPORT_C TPositionSelectionOrder();

Description

Default constructor for TPositionSelectionOrder.

IMPORT_C TInt SetOrderTimeToFirstFix(TOrder aOrder);

Description

Assigns a priority to the time to first fix when selecting a positioning module.

Parameters

TPositionSelectionOrder::TOrder aOrder is the priority of the time to first fix when choosing a positioning module.

Return value

TInt a Symbian OS error code.

IMPORT_C TInt SetOrderTimeToNextFix(TOrder aOrder);

Description

Assigns a priority to the time to subsequent fixes when selecting a positioning module.

Parameters

TPositionSelectionOrder::TOrder aOrder is the priority of the time to subsequent fixes when choosing a positioning module.

Return value

TInt a Symbian OS error code.

IMPORT_C TInt SetOrderHorizontalAccuracy(TOrder aOrder);

Description

Assigns a priority to the horizontal accuracy when selecting a positioning module.

Parameters

TPositionSelectionOrder::TOrder aOrder is the priority of horizontal accuracy when choosing a positioning module.

Return value

TInt a Symbian OS error code.

IMPORT_C TInt SetOrderVerticalAccuracy(TOrder aOrder);

Description

Assigns a priority to the vertical accuracy when selecting a positioning module.

Parameters

TPositionSelectionOrder::TOrder aOrder is the priority of vertical accuracy when choosing a positioning module.

Return value

TInt a Symbian OS error code.

IMPORT_C TInt SetOrderCostIndicator(TOrder aOrder);

Description

Assigns a priority to the cost of a positioning technology when selecting a positioning module.

Parameters

TPositionSelectionOrder::TOrder aOrder is the priority of cost when choosing a positioning module.

Return value

TInt a Symbian OS error code.

IMPORT_C TInt SetOrderPowerConsumption(TOrder aOrder);

Description

Assigns a priority to the power consumption of a positioning technology when selecting a positioning module.

Parameters

TPositionSelectionOrder::TOrder aOrder is the priority of power consumption when choosing a positioning module.

Return value

TInt a Symbian OS error code.

IMPORT_C void ResetSelectionOrder();

Description

Used to restore the default selection ordering.

IMPORT_C void ClearSelectionOrder();

Description

Clear all values including defaults. This is useful if the application wishes to specify its own priorities.

IMPORT_C TUint NumSelectionItems() const;

Description

Not generally called by client applications. It retrieves the number of selection parameters.

Return value

TUint the number of selection items.

IMPORT_C TInt GetSelectionItem(TUint aIndex, TField &aField, TOrder &aOrder) const;

Description

Not generally called by client applications. It retrieves a particular selection parameter.

Parameters

TUint aIndex the index of a selection parameter TPositionSelectionOrder::TField &aField is set, upon successful completion, to the field ID at index aIndex. TPositionSelectionOrder::TOrder &aOrder is set, upon successful completion, to the priority of the field at index aIndex.

Return value

TInt a Symbian OS error code.

protected: struct SItem;

Description

Stores a field / priority pair.

Members

Defined in TPositionSelectionOrder::SItem:

• iFieldA position quality metric identifier.
• iOrderThe priority given to the iField position quality metric.

Member data

---

iField

TField iField;

Description

A position quality metric identifier.

---

iOrder

TOrder iOrder;

Description

The priority given to the iField position quality metric.

TOrder

Description

Specifies the priority of selection parameters.

EOrderDontCare Don't care EOrderDefault Default EOrderVeryLow Very low EOrderLow Low EOrderFairlyLow Fairly low EOrderMedium Medium EOrderFairlyHigh Fairly high EOrderHigh High EOrderVeryHigh Very high

TField

Description

Specifies the quality of position metrics that can be prioritized.

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

protected: TUint iNumItems;

Description

The number of selection items in the iItems array.

protected: SItem iItems[KPositionMaxSectionFields];

Description

Array of users position quality priorities.