blob: a28529ab1c698b5a4e052f51529d1308680d726c [file] [log] [blame] [view]
<link rel="stylesheet" href="../style.css" />
[TOC]
# fuchsia.location.position
<p>Protocols and types related to positions.</p>
<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div>
## **PROTOCOLS**
## EmergencyProvider {#EmergencyProvider}
*Defined in [fuchsia.location.position/position.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.location.position/position.fidl;l=42)*
<p>Provides access to position data for emergency purposes. Implementations
of this service are expected to be subject to different power and privacy
controls than more general location services.</p>
### GetCurrent {#EmergencyProvider.GetCurrent}
<p>Returns the current position, if available.</p>
#### Request {#EmergencyProvider.GetCurrent_Request}
&lt;EMPTY&gt;
#### Response {#EmergencyProvider.GetCurrent_Response}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>result</code></td>
<td>
<code><a class='link' href='#EmergencyProvider_GetCurrent_Result'>EmergencyProvider_GetCurrent_Result</a></code>
</td>
</tr>
</table>
## **STRUCTS**
### EmergencyProvider_GetCurrent_Response {#EmergencyProvider_GetCurrent_Response data-text="EmergencyProvider_GetCurrent_Response"}
*Defined in [fuchsia.location.position/position.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.location.position/position.fidl;l=44)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="EmergencyProvider_GetCurrent_Response.position">
<td><code>position</code></td>
<td>
<code><a class='link' href='#Position'>Position</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Position {#Position data-text="Position"}
*Defined in [fuchsia.location.position/position.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.location.position/position.fidl;l=19)*
<p>Describes a position on Earth.</p>
<p>A fully-specified position includes latitude and longitude,
as well a radius of accuracy of the current position in
the horizontal plane, and the current altitude.</p>
<p>Note that only the latitude and longitude are guaranteed
to be present. The remaining fields, if present, are contained
within <code>extras</code>.</p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Position.latitude">
<td><code>latitude</code></td>
<td>
<code>float64</code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="Position.longitude">
<td><code>longitude</code></td>
<td>
<code>float64</code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="Position.extras">
<td><code>extras</code></td>
<td>
<code><a class='link' href='#PositionExtras'>PositionExtras</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
## **TABLES**
### PositionExtras {#PositionExtras data-text="PositionExtras"}
*Defined in [fuchsia.location.position/position.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.location.position/position.fidl;l=33)*
<p>Extra information about a position on Earth.</p>
<p>The radius of accuracy may incorporate any sources of
uncertainty available to the positioning system. This may include,
for example, radio propagation models, triangulation error, and
motion compensation.</p>
<p>Note that all extras are optional.</p>
<table>
<tr><th>Ordinal</th><th>Field</th><th>Type</th><th>Description</th></tr>
<tr id="PositionExtras.accuracy_meters">
<td><h3 id="PositionExtras.accuracy_meters" class="add-link hide-from-toc">1</h3></td>
<td><code>accuracy_meters</code></td>
<td>
<code>float64</code>
</td>
<td></td>
</tr>
<tr id="PositionExtras.altitude_meters">
<td><h3 id="PositionExtras.altitude_meters" class="add-link hide-from-toc">2</h3></td>
<td><code>altitude_meters</code></td>
<td>
<code>float64</code>
</td>
<td></td>
</tr>
</table>
## **UNIONS**
### EmergencyProvider_GetCurrent_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#EmergencyProvider_GetCurrent_Result data-text="EmergencyProvider_GetCurrent_Result"}
*Defined in [fuchsia.location.position/position.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.location.position/position.fidl;l=44)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="EmergencyProvider_GetCurrent_Result.response">
<td><h3 id="EmergencyProvider_GetCurrent_Result.response" class="add-link hide-from-toc">1</h3></td>
<td><code>response</code></td>
<td>
<code><a class='link' href='#EmergencyProvider_GetCurrent_Response'>EmergencyProvider_GetCurrent_Response</a></code>
</td>
<td></td>
</tr>
<tr id="EmergencyProvider_GetCurrent_Result.err">
<td><h3 id="EmergencyProvider_GetCurrent_Result.err" class="add-link hide-from-toc">2</h3></td>
<td><code>err</code></td>
<td>
<code><a class='link' href='../fuchsia.location/'>fuchsia.location</a>/<a class='link' href='../fuchsia.location/#Error'>Error</a></code>
</td>
<td></td>
</tr>
</table>