Symbian3/PDK/Source/GUID-87E9656E-CBB4-5023-B6BC-148A2957AFFC.dita
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 16 Jul 2010 17:23:46 +0100
changeset 12 80ef3a206772
parent 9 59758314f811
permissions -rw-r--r--
Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
     1
<?xml version="1.0" encoding="utf-8"?>
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
     2
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
     3
<!-- This component and the accompanying materials are made available under the terms of the License 
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
     4
"Eclipse Public License v1.0" which accompanies this distribution, 
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
     5
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
     6
<!-- Initial Contributors:
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
     7
    Nokia Corporation - initial contribution.
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
     8
Contributors: 
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
     9
-->
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    10
<!DOCTYPE concept
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    11
  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
12
80ef3a206772 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 9
diff changeset
    12
<concept xml:lang="en" id="GUID-87E9656E-CBB4-5023-B6BC-148A2957AFFC"><title>Quality Profiles Overview</title><shortdesc>A quality profile defines the minimum acceptable horizontal and vertical accuracy required for a location fix and the maximum acceptable time to obtain the fix. A quality profile is used when the client that requests a position fix does not specify any position quality criteria. </shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody><p>Sets of acceptable quality parameters are stored in <filepath>lbsprofile.ini</filepath>. The Quality Profile API enables LBS subsystem components to read the quality profile data stored in that file. </p> <p>An LBS administration setting determines which quality profile is used for different types of location request (MO-LR self locate, MO-LR transfer to third party and MT-LR). </p> <section id="GUID-DBF1C87D-7360-54B7-8658-B6659BF77F06-GENID-1-12-1-19-1-1-7-1-5-1-5-1-4-1-3-3"><title>lbsprofile.ini</title> <p>A typical quality profile file <filepath>lbsprofile.ini</filepath> is shown below. </p> <codeblock id="GUID-E049EFF4-A6DF-5A84-BCD6-5B0CA9FBECF7" xml:space="preserve">#
9
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    13
# Quality Profiles for LBS services
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    14
#
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    15
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    16
[1]
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    17
ProfileID= 0
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    18
MaxTime= 130
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    19
HorizontalAccuracy= 50
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    20
VerticalAccuracy= 1000
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    21
MeasurementInitialTime= 15
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    22
MeasurementIntermediateTime= 5
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    23
FinalNetPositionLag= 10
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    24
    
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    25
[2]
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    26
ProfileID= 1
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    27
MaxTime= 120
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    28
HorizontalAccuracy= 20
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    29
VerticalAccuracy= 1000
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    30
MeasurementInitialTime= 15
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    31
MeasurementIntermediateTime= 5</codeblock> <p>The following table describes the purpose of the parameters in <filepath>lbsprofile.ini</filepath>. </p> <table id="GUID-D544BF11-EDB4-5226-9222-1E9BAD39B307"><tgroup cols="3"><colspec colname="col0"/><colspec colname="col1"/><colspec colname="col2"/><thead><row><entry>Parameter </entry> <entry>Type</entry> <entry>Description</entry> </row> </thead> <tbody><row><entry><p>ProfileID </p> </entry> <entry><p>Integer </p> </entry> <entry><p>The ID of the profile. This must be a unique value for each quality profile defined in this file. This value is used as a key from the administration repository file. </p> </entry> </row> <row><entry><p>MaxTime </p> </entry> <entry><p>Integer </p> </entry> <entry><p>The default maximum time (in seconds) to calculate a location fix for the profile. This is the time to obtain GPS measurements and use them to calculate a fix for autonomous or terminal based GPS mode. See also <codeph>FinalNetPositionLag</codeph> below. </p> </entry> </row> <row><entry><p>HorizontalAccuracy </p> </entry> <entry><p>Float </p> </entry> <entry><p>The maximum acceptable error (in metres) in horizontal position for this quality profile. </p> </entry> </row> <row><entry><p>VerticalAccuracy </p> </entry> <entry><p>Float </p> </entry> <entry><p>The maximum acceptable error (in metres) in vertical position for this quality profile. </p> </entry> </row> <row><entry><p>MeasurementInitialTime </p> </entry> <entry><p>Float </p> </entry> <entry><p>The maximum time (in seconds) to get the first GPS measurements (but not a GPS location fix). Used in terminal assisted GPS mode. </p> </entry> </row> <row><entry><p>MeasurementIntermediateTime </p> </entry> <entry><p>Float </p> </entry> <entry><p>The maximum time (in seconds) to get subsequent GPS measurements after the first measurements have been received. </p> </entry> </row> <row><entry><p>FinalNetPositionLag </p> </entry> <entry><p>Integer </p> </entry> <entry><p>An additional time (in seconds) that the Location Server waits to receive a position update for a MO-LR self-locate before it notifies the client that the request has timed out. This additional time is to allow the "final position" to be retrieved from the network. The final position may have been calculated by a network server for Terminal Assisted Mode. </p> <p>For example, if a client application calls <codeph>RPositioner::NotifyPositionUpdate(TPositionInfoBase &amp;aPosInfo,
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    32
                  TRequestStatus &amp;aStatus)</codeph> and the profile is configured for MO-LR self locate, then the Location Server waits a total of <codeph>MaxTime</codeph> + <codeph>FinalNetPositionLag</codeph> seconds to receive a position before it completes the request with <codeph>aStatus = KErrTimedOut</codeph>. </p> <p> <b>Note:</b> if a client application sets an update timeout by calling <codeph>RPositioner::SetUpdateOptions(TPositionUpdateOptions&amp;
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    33
                  options)</codeph> and has set a timeout on the options by calling <xref href="GUID-E8ACE5F3-5479-3C86-ACC9-89190ED29649.dita"><apiname>options.SetUpdateTimeout()</apiname></xref>, then the Location Server waits a total of <xref href="GUID-4C597C79-46BB-3796-B6AA-020722D172B7.dita"><apiname>options.UpdateTimeOut() </apiname></xref> + <codeph>FinalNetPositionLag</codeph> to receive a position before it completes the request with <codeph>aStatus = KErrTimedOut</codeph>. Where <codeph>FinalNetPositionLag</codeph> is omitted from a profile, it is assumed to be 0. </p> </entry> </row> </tbody> </tgroup> </table> </section> </conbody><related-links><link href="GUID-5E6CA805-6861-54B1-8687-B997A6F4E6EE.dita"><linktext>Quality
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    34
                Profile API</linktext> </link> <link href="GUID-0D49DE9F-AE0D-552F-8769-D056BC505FC1.dita"><linktext>How
59758314f811 Week 23 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 2714, Bug 462.
Dominic Pinkman <dominic.pinkman@nokia.com>
parents: 5
diff changeset
    35
                to use the Quality Profile API</linktext> </link> <link href="GUID-D0318BB6-0B9F-5A1C-AB0B-61BA22D28661.dita"><linktext>Location Acquisition API</linktext> </link> <link href="GUID-D18B4715-3942-52EA-9D2F-E145037FA47A.dita"><linktext>LBS
1
25a17d01db0c Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff changeset
    36
                Integration and Configuration Guide</linktext> </link> </related-links></concept>