plugins/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B.html
changeset 470 d4809db37847
parent 229 716254ccbcc0
equal deleted inserted replaced
469:4d198a32ac7d 470:d4809db37847
       
     1 
       
     2 <!DOCTYPE html
       
     3   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="Returned location information"/><meta name="DC.Relation" scheme="URI" content="GUID-4541E532-CC1A-4115-8467-7FA1C4378307"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-53CE4DE6-F065-4339-8C18-5C30A9540053"/><meta name="DC.Relation" scheme="URI" content="GUID-150E440F-56E4-4249-8739-A5A7A2050600"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B"/><title>Returned
       
     5 location information </title><script type="text/javascript">
       
     6       function initPage() {}
       
     7     </script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B">Returned
       
     8 location information</h1><div>
       
     9 <p/>
       
    10 <p>The <code>ReturnValue</code> property returned by a synchronous <a href="GUID-150E440F-56E4-4249-8739-A5A7A2050600.html#GUID-150E440F-56E4-4249-8739-A5A7A2050600"><code>GetLocation</code></a> call
       
    11 and by <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> for
       
    12 an asynchronous <code>GetLocation</code> or <a href="GUID-7A0190CB-545E-48D2-BAF0-D28E03CDFCA5.html#GUID-7A0190CB-545E-48D2-BAF0-D28E03CDFCA5"><code>Trace</code></a> call
       
    13 is an object containing the requested device location information. Each property
       
    14 in the object corresponds to one kind of location information.</p>
       
    15 <p>The exact set of properties included in the <code>ReturnValue</code> object
       
    16 depends on the <a href="GUID-4541E532-CC1A-4115-8467-7FA1C4378307.html#GUID-4541E532-CC1A-4115-8467-7FA1C4378307"><span>criteria</span></a> defined
       
    17 for the <code>GetLocation</code> or <code>Trace</code> call
       
    18 and on the capabilities of the positioning system that provides the location
       
    19 information for the mobile device. If a particular piece of location information
       
    20 cannot be retrieved by the positioning system, the property for that information
       
    21 is not included in the <code>ReturnValue</code> object. For example,
       
    22 if basic location information is requested, the <code>ReturnValue</code> object
       
    23 only contains properties for longitude, latitude, and altitude; no other location
       
    24 information is returned. Similarly, if the positioning system used by the
       
    25 S60 device cannot provide satellite information, the <code>SatelliteNumView</code> and <code>SatelliteNumViewUsed</code> properties
       
    26 are not included in <code>ReturnValue</code>.</p>
       
    27 <p>The <a href="http://en.wikipedia.org/wiki/World_Geodetic_System" target="_blank">WGS
       
    28 84 datum</a> is used to reference coordinates. The representation is
       
    29 in decimal degrees.</p>
       
    30 <p>The following table describes the location information returned by a <code>GetLocation</code> or <code>Trace</code> call.</p>
       
    31 <div class="tablenoborder"><a name="GUID-E1EDEBA8-6DC8-471D-92FB-8BB4CCBB0E12"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-E1EDEBA8-6DC8-471D-92FB-8BB4CCBB0E12" frame="border" border="1" rules="all"><caption><strong>Table: </strong>ReturnValue properties
       
    32 for location information</caption>
       
    33 
       
    34 <thead align="left">
       
    35 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e48050">
       
    36 <p>Property</p>
       
    37 </th><th class="cellrowborder" valign="top" width="25%" id="d0e48055">
       
    38 <p>Description</p>
       
    39 </th><th class="cellrowborder" valign="top" width="25%" id="d0e48060">
       
    40 <p>Value type</p>
       
    41 </th><th class="cellrowborder" valign="top" width="25%" id="d0e48065">
       
    42 <p>Location information type</p>
       
    43 </th></tr>
       
    44 </thead>
       
    45 <tbody>
       
    46 <tr class="">
       
    47 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
    48 <p><code>Longitude</code></p>
       
    49 </td>
       
    50 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
    51 <p>Longitude estimate in degrees. The value range is [+180, -180].</p>
       
    52 </td>
       
    53 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
    54 <p>number</p>
       
    55 </td>
       
    56 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
    57 <p>Basic or Generic</p>
       
    58 </td>
       
    59 </tr>
       
    60 <tr class="bg ">
       
    61 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
    62 <p><code>Latitude</code></p>
       
    63 </td>
       
    64 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
    65 <p>Latitude estimate in degrees. The value range is [+90, -90].</p>
       
    66 </td>
       
    67 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
    68 <p>number</p>
       
    69 </td>
       
    70 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
    71 <p>Basic or Generic</p>
       
    72 </td>
       
    73 </tr>
       
    74 <tr class="">
       
    75 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
    76 <p><code>Altitude</code></p>
       
    77 </td>
       
    78 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
    79 <p>Elevation estimate in meters relative to the WGS 84 datum.</p>
       
    80 </td>
       
    81 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
    82 <p>number</p>
       
    83 </td>
       
    84 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
    85 <p>Basic or Generic</p>
       
    86 </td>
       
    87 </tr>
       
    88 <tr class="bg ">
       
    89 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
    90 <p><code>SatelliteNumView</code></p>
       
    91 </td>
       
    92 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
    93 <p>Number of satellites currently in view.</p>
       
    94 </td>
       
    95 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
    96 <p>number</p>
       
    97 </td>
       
    98 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
    99 <p>Generic</p>
       
   100 </td>
       
   101 </tr>
       
   102 <tr class="">
       
   103 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   104 <p><code>SatelliteNumViewUsed</code></p>
       
   105 </td>
       
   106 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   107 <p>Number of satellites used to obtain the location fix.</p>
       
   108 </td>
       
   109 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   110 <p>number</p>
       
   111 </td>
       
   112 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   113 <p>Generic</p>
       
   114 </td>
       
   115 </tr>
       
   116 <tr class="bg ">
       
   117 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   118 <p><code>HorizontalSpeed</code></p>
       
   119 </td>
       
   120 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   121 <p>Horizontal speed estimate in meters per second. This is the speed of
       
   122 the device at the time the location fix was obtained.</p>
       
   123 </td>
       
   124 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   125 <p>number</p>
       
   126 </td>
       
   127 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   128 <p>Generic</p>
       
   129 </td>
       
   130 </tr>
       
   131 <tr class="">
       
   132 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   133 <p><code>HorizontalSpeedError</code></p>
       
   134 </td>
       
   135 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   136 <p>Horizontal speed error in meters per second.</p>
       
   137 </td>
       
   138 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   139 <p>number</p>
       
   140 </td>
       
   141 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   142 <p>Generic</p>
       
   143 </td>
       
   144 </tr>
       
   145 <tr class="bg ">
       
   146 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   147 <p><code>TrueCourse</code></p>
       
   148 </td>
       
   149 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   150 <p>Current direction of movement in degrees in relation to true north.</p>
       
   151 </td>
       
   152 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   153 <p>number</p>
       
   154 </td>
       
   155 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   156 <p>Generic</p>
       
   157 </td>
       
   158 </tr>
       
   159 <tr class="">
       
   160 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   161 <p><code>TrueCourseError</code></p>
       
   162 </td>
       
   163 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   164 <p><code>TrueCourse</code> error in degrees.</p>
       
   165 </td>
       
   166 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   167 <p>number</p>
       
   168 </td>
       
   169 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   170 <p>Generic</p>
       
   171 </td>
       
   172 </tr>
       
   173 <tr class="bg ">
       
   174 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   175 <p><code>MagneticHeading</code></p>
       
   176 </td>
       
   177 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   178 <p>Current direction of movement in degrees in relation to magnetic north.</p>
       
   179 </td>
       
   180 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   181 <p>number</p>
       
   182 </td>
       
   183 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   184 <p>Generic</p>
       
   185 </td>
       
   186 </tr>
       
   187 <tr class="">
       
   188 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   189 <p><code>MagneticHeadingError</code></p>
       
   190 </td>
       
   191 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   192 <p><code>MagneticHeading</code> error in degrees.</p>
       
   193 </td>
       
   194 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   195 <p>number</p>
       
   196 </td>
       
   197 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   198 <p>Generic</p>
       
   199 </td>
       
   200 </tr>
       
   201 <tr class="bg ">
       
   202 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   203 <p><code>Heading</code></p>
       
   204 </td>
       
   205 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   206 <p>Current instantaneous direction of movement in degrees in relation to
       
   207 true north.</p>
       
   208 <p/>
       
   209 </td>
       
   210 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   211 <p>number</p>
       
   212 </td>
       
   213 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   214 <p>Generic</p>
       
   215 </td>
       
   216 </tr>
       
   217 <tr class="">
       
   218 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   219 <p><code>HeadingError</code></p>
       
   220 </td>
       
   221 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   222 <p><code>Heading</code> error in degrees.</p>
       
   223 </td>
       
   224 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   225 <p>number</p>
       
   226 </td>
       
   227 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   228 <p>Generic</p>
       
   229 </td>
       
   230 </tr>
       
   231 <tr class="bg ">
       
   232 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   233 <p><code>MagneticCourse</code></p>
       
   234 </td>
       
   235 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   236 <p>Current instantaneous direction of movement in degrees in relation to
       
   237 magnetic north.</p>
       
   238 <p/>
       
   239 </td>
       
   240 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   241 <p>number</p>
       
   242 </td>
       
   243 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   244 <p>Generic</p>
       
   245 </td>
       
   246 </tr>
       
   247 <tr class="">
       
   248 <td class="cellrowborder" valign="top" width="25%" headers="d0e48050 ">
       
   249 <p><code>MagneticCourseError</code></p>
       
   250 </td>
       
   251 <td class="cellrowborder" valign="top" width="25%" headers="d0e48055 ">
       
   252 <p><code>MagneticCourse</code> error in degrees.</p>
       
   253 </td>
       
   254 <td class="cellrowborder" valign="top" width="25%" headers="d0e48060 ">
       
   255 <p>number</p>
       
   256 </td>
       
   257 <td class="cellrowborder" valign="top" width="25%" headers="d0e48065 ">
       
   258 <p>Generic</p>
       
   259 </td>
       
   260 </tr>
       
   261 </tbody>
       
   262 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>