TPositionSelectionOrder Class Reference

#include <lbscriteria.h>

Link against: lbs.lib

class TPositionSelectionOrder

Nested Classes and Structures

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

Member Attribute Documentation

iItems

SItem iItems[protected]

Array of users position quality priorities.

iNumItems

TUint iNumItems[protected]

The number of selection items in the iItems array.

Member Enumeration Documentation

Enum TField

Specifies the quality of position metrics that can be prioritized.

EnumeratorValueDescription
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

EFieldLastKMaxTInt8

Last field

Enum TOrder

Specifies the priority of selection parameters.

EnumeratorValueDescription
EOrderDontCare0

Don't care

EOrderDefault1

Default

EOrderVeryLow25

Very low

EOrderLow50

Low

EOrderFairlyLow75

Fairly low

EOrderMedium100

Medium

EOrderFairlyHigh125

Fairly high

EOrderHigh150

High

EOrderVeryHigh175

Very high

Constructor & Destructor Documentation

TPositionSelectionOrder ( )

IMPORT_CTPositionSelectionOrder()

Default constructor for TPositionSelectionOrder.

Member Function Documentation

AddItem ( TField, TOrder )

TInt AddItem(TFieldaField,
TOrderaOrder
)[protected]

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.

Parameters
aFieldis a position quality metric, eg. horizontal accuracy
aOrderis the priority for the given quality metric.
Return Value
a Symbian OS error code.

ClearSelectionOrder ( )

IMPORT_C voidClearSelectionOrder()

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

GetSelectionItem ( TUint, TField &, TOrder & )

IMPORT_C TIntGetSelectionItem(TUintaIndex,
TField &aField,
TOrder &aOrder
)const

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

Parameters
aIndexthe index of a selection parameter
aFieldis set, upon successful completion, to the field ID at index aIndex.
aOrderis set, upon successful completion, to the priority of the field at index aIndex.
Return Value
a Symbian OS error code.

NumSelectionItems ( )

IMPORT_C TUintNumSelectionItems()const

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

Return Value
the number of selection items.

ResetSelectionOrder ( )

IMPORT_C voidResetSelectionOrder()

Used to restore the default selection ordering.

SetOrderCostIndicator ( TOrder )

IMPORT_C TIntSetOrderCostIndicator(TOrderaOrder)

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

Parameters
aOrderis the priority of cost when choosing a positioning module.
Return Value
a Symbian OS error code.

SetOrderHorizontalAccuracy ( TOrder )

IMPORT_C TIntSetOrderHorizontalAccuracy(TOrderaOrder)

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

Parameters
aOrderis the priority of horizontal accuracy when choosing a positioning module.
Return Value
a Symbian OS error code.

SetOrderPowerConsumption ( TOrder )

IMPORT_C TIntSetOrderPowerConsumption(TOrderaOrder)

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

Parameters
aOrderis the priority of power consumption when choosing a positioning module.
Return Value
a Symbian OS error code.

SetOrderTimeToFirstFix ( TOrder )

IMPORT_C TIntSetOrderTimeToFirstFix(TOrderaOrder)

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

Parameters
aOrderis the priority of the time to first fix when choosing a positioning module.
Return Value
a Symbian OS error code.

SetOrderTimeToNextFix ( TOrder )

IMPORT_C TIntSetOrderTimeToNextFix(TOrderaOrder)

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

Parameters
aOrderis the priority of the time to subsequent fixes when choosing a positioning module.
Return Value
a Symbian OS error code.

SetOrderVerticalAccuracy ( TOrder )

IMPORT_C TIntSetOrderVerticalAccuracy(TOrderaOrder)

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

Parameters
aOrderis the priority of vertical accuracy when choosing a positioning module.
Return Value
a Symbian OS error code.