S60 3rd Edition API Reference: TPositionSelectionOrder Class Reference

TPositionSelectionOrder Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

Location

#include <lbscriteria.h>

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.


Public Types

enum  TOrder {
  EOrderDontCare = 0, EOrderDefault = 1, EOrderVeryLow = 25, EOrderLow = 50,
  EOrderFairlyLow = 75, EOrderMedium = 100, EOrderFairlyHigh = 125, EOrderHigh = 150,
  EOrderVeryHigh = 175
}
 Specifies the priority of selection parameters. More...
enum  TField {
  EFieldTimeToFirstFix, EFieldTimeToNextFix, EFieldHorizontalAccuracy, EFieldVerticalAccuracy,
  EFieldCost, EFieldPower, EFieldNumFields, EFieldLast = KMaxTInt8
}
 Specifies the quality of position metrics that can be prioritized. More...

Public Member Functions

IMPORT_C TPositionSelectionOrder ()
 Default constructor for TPositionSelectionOrder.
IMPORT_C TInt SetOrderTimeToFirstFix (TOrder aOrder)
 Assigns a priority to the time to first fix when selecting a positioning module.
IMPORT_C TInt SetOrderTimeToNextFix (TOrder aOrder)
 Assigns a priority to the time to subsequent fixes when selecting a positioning module.
IMPORT_C TInt SetOrderHorizontalAccuracy (TOrder aOrder)
 Assigns a priority to the horizontal accuracy when selecting a positioning module.
IMPORT_C TInt SetOrderVerticalAccuracy (TOrder aOrder)
 Assigns a priority to the vertical accuracy when selecting a positioning module.
IMPORT_C TInt SetOrderCostIndicator (TOrder aOrder)
 Assigns a priority to the cost of a positioning technology when selecting a positioning module.
IMPORT_C TInt SetOrderPowerConsumption (TOrder aOrder)
 Assigns a priority to the power consumption of a positioning technology when selecting a positioning module.
IMPORT_C void ResetSelectionOrder ()
 Used to restore the default selection ordering.
IMPORT_C void ClearSelectionOrder ()
 Clear all values including defaults.
IMPORT_C TUint NumSelectionItems () const
 Not generally called by client applications.
IMPORT_C TInt GetSelectionItem (TUint aIndex, TField &aField, TOrder &aOrder) const
 Not generally called by client applications.

Protected Member Functions

TInt AddItem (TField aField, TOrder aOrder)

Protected Attributes

TUint iNumItems
 The number of selection items in the iItems array.
SItem iItems [KPositionMaxSectionFields]
 Array of users position quality priorities.

Data Structures

struct  SItem
 Stores a field / priority pair. More...

Member Enumeration Documentation

enum TPositionSelectionOrder::TField
 

Specifies the quality of position metrics that can be prioritized.

Enumerator:
EFieldTimeToFirstFix 
EFieldTimeToNextFix 
EFieldHorizontalAccuracy 
EFieldVerticalAccuracy 
EFieldCost 
EFieldPower 
EFieldNumFields 
EFieldLast 
enum TPositionSelectionOrder::TOrder
 

Specifies the priority of selection parameters.

Enumerator:
EOrderDontCare 
EOrderDefault 
EOrderVeryLow 
EOrderLow 
EOrderFairlyLow 
EOrderMedium 
EOrderFairlyHigh 
EOrderHigh 
EOrderVeryHigh 

Constructor & Destructor Documentation

IMPORT_C TPositionSelectionOrder::TPositionSelectionOrder (   ) 
 

Default constructor for TPositionSelectionOrder.

Member Function Documentation

TInt TPositionSelectionOrder::AddItem ( TField  aField,
TOrder  aOrder
)  [protected]
 
IMPORT_C void TPositionSelectionOrder::ClearSelectionOrder (   ) 
 

Clear all values including defaults.

This is useful if the application wishes to specify its own priorities.

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

Not generally called by client applications.

It retrieves a particular selection parameter.

Parameters:
aIndex the index of a selection parameter
[out] aField is set, upon successful completion, to the field ID at index aIndex.
[out] aOrder is set, upon successful completion, to the priority of the field at index aIndex.
Returns:
a Symbian OS error code.
IMPORT_C TUint TPositionSelectionOrder::NumSelectionItems (   )  const
 

Not generally called by client applications.

It retrieves the number of selection parameters.

Returns:
the number of selection items.
IMPORT_C void TPositionSelectionOrder::ResetSelectionOrder (   ) 
 

Used to restore the default selection ordering.

IMPORT_C TInt TPositionSelectionOrder::SetOrderCostIndicator ( TOrder  aOrder  ) 
 

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

Parameters:
aOrder is the priority of cost when choosing a positioning module.
Returns:
a Symbian OS error code.
IMPORT_C TInt TPositionSelectionOrder::SetOrderHorizontalAccuracy ( TOrder  aOrder  ) 
 

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

Parameters:
aOrder is the priority of horizontal accuracy when choosing a positioning module.
Returns:
a Symbian OS error code.
IMPORT_C TInt TPositionSelectionOrder::SetOrderPowerConsumption ( TOrder  aOrder  ) 
 

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

Parameters:
aOrder is the priority of power consumption when choosing a positioning module.
Returns:
a Symbian OS error code.
IMPORT_C TInt TPositionSelectionOrder::SetOrderTimeToFirstFix ( TOrder  aOrder  ) 
 

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

Parameters:
aOrder is the priority of the time to first fix when choosing a positioning module.
Returns:
a Symbian OS error code.
IMPORT_C TInt TPositionSelectionOrder::SetOrderTimeToNextFix ( TOrder  aOrder  ) 
 

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

Parameters:
aOrder is the priority of the time to subsequent fixes when choosing a positioning module.
Returns:
a Symbian OS error code.
IMPORT_C TInt TPositionSelectionOrder::SetOrderVerticalAccuracy ( TOrder  aOrder  ) 
 

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

Parameters:
aOrder is the priority of vertical accuracy when choosing a positioning module.
Returns:
a Symbian OS error code.

Field Documentation

SItem TPositionSelectionOrder::iItems[KPositionMaxSectionFields] [protected]
 

Array of users position quality priorities.

TUint TPositionSelectionOrder::iNumItems [protected]
 

The number of selection items in the iItems array.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top