org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-9115340A-5D15-4139-A236-945D199583AF.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Fri, 04 Jun 2010 09:44:40 -0700
changeset 345 7723a46fe224
parent 229 716254ccbcc0
permissions -rw-r--r--
Bug 2480 - Excluded resources are still available in preview and debugger


<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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="Calculation criteria"/><meta name="DC.Relation" scheme="URI" content="GUID-B1BFA47E-DAC0-40B1-898E-B3FCE14AE78F"/><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-DBEE8177-7246-4FEE-A0F1-D6AEEA6EA206"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-9115340A-5D15-4139-A236-945D199583AF"/><title>Calculation criteria </title><script type="text/javascript">
      function initPage() {}
    </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-9115340A-5D15-4139-A236-945D199583AF">Calculation <span>criteria</span></h1><div>
<p>The <code>criteria</code> object specifies the mathematical
operation to perform and the input values to use in the operation.</p>
<p>The <a href="GUID-DBEE8177-7246-4FEE-A0F1-D6AEEA6EA206.html#GUID-DBEE8177-7246-4FEE-A0F1-D6AEEA6EA206"><code>Calculate</code></a> method
supports the following operations:</p>
<ul>
<li><p><code>FindDistance</code></p>

<p>This operation calculates the distance between two locations. The operation
takes as input the coordinates of the source location and target location.
The return value is the distance in meters.</p>

</li>
<li><p><code>FindBearingTo</code></p>

<p>This operation calculates the bearing to a target location from a source
location. The operation takes as input the coordinates of the source location
and target location. The return value is the bearing in degrees counting clockwise
relative to true north.</p>

</li>
<li><p><code>MoveCoordinates</code></p>

<p>This operation calculates a new location based on movement from a source
location. The operation takes as input the coordinates of the source location,
the distance moved, and the direction of the movement. The return value consists
of the coordinates of the new location.</p>

</li>
</ul>
<p>The operations require different input parameters, as summarized in
the following table. The properties that contain the input are described in
detail in <a href="#GUID-65A57F20-7AC7-433C-ABD3-B838C147865A">Table:
Criteria object properties</a>. The return values are described in section <a href="GUID-B1BFA47E-DAC0-40B1-898E-B3FCE14AE78F.html#GUID-B1BFA47E-DAC0-40B1-898E-B3FCE14AE78F">Calculation results</a>.</p>
<div class="tablenoborder"><a name="GUID-544FDA8E-654F-47EA-B98C-CFC274F5D943"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-544FDA8E-654F-47EA-B98C-CFC274F5D943" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Supported operations
and their input</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="50%" id="d0e49092">
<p>Operation</p>
</th><th class="cellrowborder" valign="top" width="50%" id="d0e49097">
<p>Input</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="50%" headers="d0e49092 ">
<p><code>FindDistance</code></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="d0e49097 ">
<p><code>DistanceParamSource</code></p>
<p><code>DistanceParamDestination</code></p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="50%" headers="d0e49092 ">
<p><code>FindBearingTo</code></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="d0e49097 ">
<p><code>DistanceParamSource</code></p>
<p><code>DistanceParamDestination</code></p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="50%" headers="d0e49092 ">
<p><code>MoveCoordinates</code></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="d0e49097 ">
<p><code>DistanceParamSource</code></p>
<p><code>MoveByThisDistance</code></p>
<p><code>MoveByThisBearing</code></p>
</td>
</tr>
</tbody>
</table></div>
<p/>
<div class="note"><p><strong class="note_title">Note: </strong>If a longitude or latitude value in the input is outside the expected
range (see the following table), the system attempts to correct the value
automatically. For example, if longitude is set to +185 and latitude to +45,
this is passed on as longitude -175 and latitude +45, since +185 is outside
the expected longitude range of [+180.00, -180.00].</p>
<p>Moreover, if a latitude value is outside the expected range, the system
may need to adjust both the latitude and longitude to arrive at the correct
coordinates. For example, if longitude is set to +10 and latitude to +95,
a point on the Western hemisphere near the North Pole, these are adjusted
to longitude -170 and latitude +85. In this case, it is necessary to adjust
both values to maintain the correct location, even though only the original
latitude value is outside the expected range. If only the latitude value were
adjusted, the coordinates (longitude +10, latitude +85) would point to a location
on the Eastern hemisphere.</p>
</div>
<p>The following table describes the properties of the <code>criteria</code> object. Properties enclosed
in brackets are optional.</p>
<div class="tablenoborder"><a name="GUID-65A57F20-7AC7-433C-ABD3-B838C147865A"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-65A57F20-7AC7-433C-ABD3-B838C147865A" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e49211">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e49216">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e49221">
<p>Type</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e49226">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>criteria.MathRequest</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the mathematical operation to perform.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>Possible values:</p>
<ul>
<li><p><code>"FindDistance"</code></p></li>
<li><p><code>"FindBearingTo"</code></p></li>
<li><p><code>"MoveCoordinates"</code></p></li>
</ul>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>criteria.DistanceParamSource</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the coordinates of the source location.</p>
<p>Use the <a href="http://en.wikipedia.org/wiki/World_Geodetic_System" target="_blank">WGS
84 datum</a> with decimal degree representation to reference coordinates.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>criteria.DistanceParamSource.Longitude</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the longitude coordinate of the source location.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>[+180.00, -180.00]</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>criteria.DistanceParamSource.Latitude</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the latitude coordinate of the source location.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>[+90.00, -90.00]</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>criteria.DistanceParamSource.Altitude</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the altitude coordinate of the source location.</p>
<p>The altitude value does not affect the result of the calculation. It
is included to maintain a uniform input argument.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>Any integer or decimal</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>[criteria.DistanceParamDestination]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the coordinates of the target location.</p>
<p>This property and its child properties are required when <code>MathRequest</code> is
set to <code>FindDistance</code> or <code>FindBearingTo</code>.</p>
<p>Use the <a href="http://en.wikipedia.org/wiki/World_Geodetic_System" target="_blank">WGS
84 datum</a> with decimal degree representation to reference coordinates.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>[criteria.DistanceParamDestination.Longitude]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the longitude coordinate of the target location.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>[+180.00, -180.00]</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>[criteria.DistanceParamDestination.Latitude]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the latitude coordinate of the target location.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>[+90.00, -90.00]</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>[criteria.DistanceParamDestination.Altitude]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the altitude coordinate of the target location.</p>
<p>The altitude value does not affect the result of the calculation. It
is included to maintain a uniform input argument.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>Any integer or decimal</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>[criteria.MoveByThisDistance]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the distance moved, that is, the distance between the source
location and the new location. The distance is in meters.</p>
<p>This property is required when <code>MathRequest</code> is set
to <code>MoveCoordinates</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>Any integer or decimal</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e49211 ">
<p><code>[criteria.MoveByThisBearing]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49216 ">
<p>Specifies the direction of movement from the source location. The direction
is expressed in degrees counting clockwise relative to true north.</p>
<p>This property is required when <code>MathRequest</code> is set
to <code>MoveCoordinates</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49221 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e49226 ">
<p>Any integer or decimal</p>
</td>
</tr>
</tbody>
</table></div>
<p/>
</div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>