Quality Profile API Overview

Purpose

This document describes the Quality Profile API which can be used by LBS system components (such as a Network Protocol Module, or A-GPS Integration Module) to get information about LBS quality profiles.

When an application or network-based service makes a location request it can supply quality criteria as part of the request. The supplied quality criteria are used by LBS to choose the most appropriate positioning technology to use to get the location fix. When not quality criteria are supplied, LBS uses a Quality Profile to obtain default quality criteria.

Quality Profile API library detail

Description

The Quality Profile API is defined by the class CLbsQualityProfileApi.

class CLbsQualityProfileApi : public CBase
 {
 public:
  IMPORT_C static CLbsQualityProfileApi* NewL();
  virtual ~CLbsQualityProfileApi();
  template <typename T> inline TInt Get(const TLbsQualityProfileId& aProfileId,
                                        const TLbsQualityProfileApiSetting& aSetting,
                                        T& aValue) const;
    
};

The API is defined in lbsqualityprofileapi.h and packaged in lbsqualityprofileapi.dll. Components that use the API link to lbsqualityprofileapi.lib.

Each one of the quality profile values defined in lbsprofile.ini can be retrieved by calling the template function CLbsQualityProfileApi::Get(), passing three parameters:

• A TLbsQualityProfileId reference. This specifies the quality profile ID as defined by ProfileID in lbsprofile.ini.

• A TLbsQualityProfileApiSetting reference. This specifies the particular data value to be obtained for the quality profile, such as MaxTime or HorizontalAccuracy.

• A reference of the appropriate type to store the quality profile value. This is a reference of type TReal32 to obtain horizontal and vertical accuracy values, or TTimeIntervalMicroSeconds to obtain time values.

Using the Quality Profile API

See How to use the Quality Profile API