Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: LbsCriteria.h
Link against: lbsselflocate.lib

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(), EFieldCost, EFieldHorizontalAccuracy, EFieldLast, EFieldNumFields, EFieldPower, EFieldTimeToFirstFix, EFieldTimeToNextFix, EFieldVerticalAccuracy, EOrderDefault, EOrderDontCare, EOrderFairlyHigh, EOrderFairlyLow, EOrderHigh, EOrderLow, EOrderMedium, EOrderVeryHigh, EOrderVeryLow, GetSelectionItem(), NumSelectionItems(), ResetSelectionOrder(), SItem, SetOrderCostIndicator(), SetOrderHorizontalAccuracy(), SetOrderPowerConsumption(), SetOrderTimeToFirstFix(), SetOrderTimeToNextFix(), SetOrderVerticalAccuracy(), TField, TOrder, TPositionSelectionOrder(), iItems, iNumItems


Construction and destruction


TPositionSelectionOrder()

IMPORT_C TPositionSelectionOrder();

Description

Default constructor for TPositionSelectionOrder.

[Top]


Member functions


SetOrderTimeToFirstFix()

IMPORT_C TInt SetOrderTimeToFirstFix(TOrder aOrder);

Description

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

Parameters

TOrder aOrder

is the priority of the time to first fix when choosing a positioning module.

Return value

TInt

a Symbian OS error code.


SetOrderTimeToNextFix()

IMPORT_C TInt SetOrderTimeToNextFix(TOrder aOrder);

Description

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

Parameters

TOrder aOrder

is the priority of the time to subsequent fixes when choosing a positioning module.

Return value

TInt

a Symbian OS error code.


SetOrderHorizontalAccuracy()

IMPORT_C TInt SetOrderHorizontalAccuracy(TOrder aOrder);

Description

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

Parameters

TOrder aOrder

is the priority of horizontal accuracy when choosing a positioning module.

Return value

TInt

a Symbian OS error code.


SetOrderVerticalAccuracy()

IMPORT_C TInt SetOrderVerticalAccuracy(TOrder aOrder);

Description

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

Parameters

TOrder aOrder

is the priority of vertical accuracy when choosing a positioning module.

Return value

TInt

a Symbian OS error code.


SetOrderCostIndicator()

IMPORT_C TInt SetOrderCostIndicator(TOrder aOrder);

Description

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

Parameters

TOrder aOrder

is the priority of cost when choosing a positioning module.

Return value

TInt

a Symbian OS error code.


SetOrderPowerConsumption()

IMPORT_C TInt SetOrderPowerConsumption(TOrder aOrder);

Description

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

Parameters

TOrder aOrder

is the priority of power consumption when choosing a positioning module.

Return value

TInt

a Symbian OS error code.


ResetSelectionOrder()

IMPORT_C void ResetSelectionOrder();

Description

Used to restore the default selection ordering.


ClearSelectionOrder()

IMPORT_C void ClearSelectionOrder();

Description

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


NumSelectionItems()

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.


GetSelectionItem()

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

TField &aField

is set, upon successful completion, to the field ID at index aIndex.

TOrder &aOrder

is set, upon successful completion, to the priority of the field at index aIndex.

Return value

TInt

a Symbian OS error code.

[Top]


Member structures


Struct SItem

protected: struct SItem;

Description

Stores a field / priority pair.

Members

Defined in TPositionSelectionOrder::SItem:
iField, iOrder

Member data


iField

TField iField;

Description

A position quality metric identifier.


iOrder

TOrder iOrder;

Description

The priority given to the iField position quality metric.

[Top]


Member enumerations


Enum TOrder

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


Enum TField

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

[Top]


Member data


iNumItems

protected: TUint iNumItems;

Description

The number of selection items in the iItems array.


iItems

protected: SItem iItems;

Description

Array of users position quality priorities.