Collapse all Symbian^3 Application Developer Library

TPositionSelectionOrder Class Reference

class TPositionSelectionOrder

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.

Nested Classes and Structures

TPositionSelectionOrder::SItem

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 )

Public Member Enumerations
enum	TField { EFieldTimeToFirstFix , EFieldTimeToNextFix , EFieldHorizontalAccuracy , EFieldVerticalAccuracy , EFieldCost , EFieldPower , EFieldNumFields , EFieldLast = KMaxTInt8 }
enum	TOrder { EOrderDontCare = 0, EOrderDefault = 1, EOrderVeryLow = 25, EOrderLow = 50, EOrderFairlyLow = 75, EOrderMedium = 100, EOrderFairlyHigh = 125, EOrderHigh = 150, EOrderVeryHigh = 175 }

Protected Attributes
SItem	iItems
TUint	iNumItems

Constructor & Destructor Documentation

TPositionSelectionOrder()

IMPORT_C

TPositionSelectionOrder

(

)

Default constructor for TPositionSelectionOrder .

Member Functions Documentation

AddItem(TField, TOrder)

TInt	AddItem	(	TField	aField,
			TOrder	aOrder
		)	[protected]

An internal method to add a selection criteria choice to the current set of criteria.

Parameters

TField aField	is a position quality metric, eg. horizontal accuracy
TOrder aOrder	is the priority for the given quality metric.

ClearSelectionOrder()

IMPORT_C void

ClearSelectionOrder

(

)

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

GetSelectionItem(TUint, TField &, TOrder &)

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

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.

NumSelectionItems()

IMPORT_C TUint

NumSelectionItems

(

)

const

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

ResetSelectionOrder()

IMPORT_C void

ResetSelectionOrder

(

)

Used to restore the default selection ordering.

SetOrderCostIndicator(TOrder)

IMPORT_C TInt

SetOrderCostIndicator

(

TOrder

aOrder

)

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.

SetOrderHorizontalAccuracy(TOrder)

IMPORT_C TInt

SetOrderHorizontalAccuracy

(

TOrder

aOrder

)

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.

SetOrderPowerConsumption(TOrder)

IMPORT_C TInt

SetOrderPowerConsumption

(

TOrder

aOrder

)

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.

SetOrderTimeToFirstFix(TOrder)

IMPORT_C TInt

SetOrderTimeToFirstFix

(

TOrder

aOrder

)

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.

SetOrderTimeToNextFix(TOrder)

IMPORT_C TInt

SetOrderTimeToNextFix

(

TOrder

aOrder

)

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.

SetOrderVerticalAccuracy(TOrder)

IMPORT_C TInt

SetOrderVerticalAccuracy

(

TOrder

aOrder

)

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.

Member Enumerations Documentation

Enum TField

Specifies the quality of position metrics that can be prioritized.

Enumerators

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

Enum TOrder

Specifies the priority of selection parameters.

Enumerators

EOrderDontCare = 0	Don't care
EOrderDefault = 1	Default
EOrderVeryLow = 25	Very low
EOrderLow = 50	Low
EOrderFairlyLow = 75	Fairly low
EOrderMedium = 100	Medium
EOrderFairlyHigh = 125	Fairly high
EOrderHigh = 150	High
EOrderVeryHigh = 175	Very high

Member Data Documentation

SItem iItems

SItem

iItems

[protected]

Array of users position quality priorities.

TUint iNumItems

TUint

iNumItems

[protected]

The number of selection items in the iItems array.