NmeaParser/api/uwp/NmeaParser.Messages.Rmb.html

323 lines
15 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Rmb </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Rmb ">
<meta name="description" content="Recommended minimum navigation information">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="NmeaParser.Messages.Rmb">
<h1 id="NmeaParser_Messages_Rmb" data-uid="NmeaParser.Messages.Rmb" class="text-break">Class Rmb</h1>
<div class="markdown level0 summary"><p>Recommended minimum navigation information</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div class="level1"><a class="xref" href="NmeaParser.Messages.NmeaMessage.html">NmeaMessage</a></div>
<div class="level2"><span class="xref">Rmb</span></div>
</div>
<div class="implements">
<h5>Implements</h5>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a>&lt;<a class="xref" href="NmeaParser.Messages.NmeaMessage.html">NmeaMessage</a>&gt;</div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.RegisterAssembly.html#NmeaParser_Messages_NmeaMessage_RegisterAssembly_System_Reflection_Assembly_System_Boolean_">NmeaMessage.RegisterAssembly(Assembly, bool)</a>
</div>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.RegisterNmeaMessage.html#NmeaParser_Messages_NmeaMessage_RegisterNmeaMessage_System_Reflection_TypeInfo_System_String_System_Boolean_">NmeaMessage.RegisterNmeaMessage(TypeInfo, string, bool)</a>
</div>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.Parse.html#NmeaParser_Messages_NmeaMessage_Parse_System_String_NmeaParser_IMultiSentenceMessage_System_Boolean_">NmeaMessage.Parse(string, IMultiSentenceMessage, bool)</a>
</div>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.MessageParts.html#NmeaParser_Messages_NmeaMessage_MessageParts">NmeaMessage.MessageParts</a>
</div>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.MessageType.html#NmeaParser_Messages_NmeaMessage_MessageType">NmeaMessage.MessageType</a>
</div>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.TalkerId.html#NmeaParser_Messages_NmeaMessage_TalkerId">NmeaMessage.TalkerId</a>
</div>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.IsProprietary.html#NmeaParser_Messages_NmeaMessage_IsProprietary">NmeaMessage.IsProprietary</a>
</div>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.ToString.html#NmeaParser_Messages_NmeaMessage_ToString">NmeaMessage.ToString()</a>
</div>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.Checksum.html#NmeaParser_Messages_NmeaMessage_Checksum">NmeaMessage.Checksum</a>
</div>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.Equals.html#NmeaParser_Messages_NmeaMessage_Equals_NmeaParser_Messages_NmeaMessage_">NmeaMessage.Equals(NmeaMessage)</a>
</div>
<div>
<a class="xref" href="NmeaParser.Messages.NmeaMessage.Timestamp.html#NmeaParser_Messages_NmeaMessage_Timestamp">NmeaMessage.Timestamp</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="NmeaParser.html">NmeaParser</a>.<a class="xref" href="NmeaParser.Messages.html">Messages</a></h6>
<h6><strong>Assembly</strong>: NmeaParser.dll</h6>
<h5 id="NmeaParser_Messages_Rmb_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[NmeaMessageType(&quot;--RMB&quot;)]
public class Rmb : NmeaMessage, IEquatable&lt;NmeaMessage&gt;</code></pre>
</div>
<h5 id="NmeaParser_Messages_Rmb_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>Navigation data from present position to a destination waypoint provided by a Loran-C, GNSS, DECCA, navigation computer
or other integrated navigation system.</p>
<p>
This sentence always accompanies <a class="xref" href="NmeaParser.Messages.Rma.html">Rma</a> and <a class="xref" href="NmeaParser.Messages.Rmc.html">Rmc</a> sentences when a destination is active when provided by a Loran-C or GNSS receiver,
other systems may transmit <a class="xref" href="NmeaParser.Messages.Rmb.html">Rmb</a> without <a class="xref" href="NmeaParser.Messages.Rma.html">Rma</a> or <a class="xref" href="NmeaParser.Messages.Rmc.html">Rmc</a>.
</p>
</div>
<h3 id="constructors">Constructors
</h3>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td id="NmeaParser_Messages_Rmb__ctor_System_String_System_String___" data-uid="NmeaParser.Messages.Rmb.#ctor(System.String,System.String[])">
<a class="xref" href="NmeaParser.Messages.Rmb.-ctor.html#NmeaParser_Messages_Rmb__ctor_System_String_System_String___">Rmb(string, string[])</a>
</td>
<td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="NmeaParser.Messages.Rmb.html">Rmb</a> class.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td id="NmeaParser_Messages_Rmb_Arrived" data-uid="NmeaParser.Messages.Rmb.Arrived">
<a class="xref" href="NmeaParser.Messages.Rmb.Arrived.html#NmeaParser_Messages_Rmb_Arrived">Arrived</a>
</td>
<td class="markdown level1 summary"><p>Arrived (<code>true</code> if arrived)</p>
</td>
</tr>
<tr>
<td id="NmeaParser_Messages_Rmb_CrossTrackError" data-uid="NmeaParser.Messages.Rmb.CrossTrackError">
<a class="xref" href="NmeaParser.Messages.Rmb.CrossTrackError.html#NmeaParser_Messages_Rmb_CrossTrackError">CrossTrackError</a>
</td>
<td class="markdown level1 summary"><p>Cross-track error (steer left when negative, right when positive)</p>
</td>
</tr>
<tr>
<td id="NmeaParser_Messages_Rmb_DestinationLatitude" data-uid="NmeaParser.Messages.Rmb.DestinationLatitude">
<a class="xref" href="NmeaParser.Messages.Rmb.DestinationLatitude.html#NmeaParser_Messages_Rmb_DestinationLatitude">DestinationLatitude</a>
</td>
<td class="markdown level1 summary"><p>Destination Latitude</p>
</td>
</tr>
<tr>
<td id="NmeaParser_Messages_Rmb_DestinationLongitude" data-uid="NmeaParser.Messages.Rmb.DestinationLongitude">
<a class="xref" href="NmeaParser.Messages.Rmb.DestinationLongitude.html#NmeaParser_Messages_Rmb_DestinationLongitude">DestinationLongitude</a>
</td>
<td class="markdown level1 summary"><p>Destination Longitude</p>
</td>
</tr>
<tr>
<td id="NmeaParser_Messages_Rmb_DestinationWaypointId" data-uid="NmeaParser.Messages.Rmb.DestinationWaypointId">
<a class="xref" href="NmeaParser.Messages.Rmb.DestinationWaypointId.html#NmeaParser_Messages_Rmb_DestinationWaypointId">DestinationWaypointId</a>
</td>
<td class="markdown level1 summary"><p>Destination waypoint ID</p>
</td>
</tr>
<tr>
<td id="NmeaParser_Messages_Rmb_OriginWaypointId" data-uid="NmeaParser.Messages.Rmb.OriginWaypointId">
<a class="xref" href="NmeaParser.Messages.Rmb.OriginWaypointId.html#NmeaParser_Messages_Rmb_OriginWaypointId">OriginWaypointId</a>
</td>
<td class="markdown level1 summary"><p>Origin waypoint ID</p>
</td>
</tr>
<tr>
<td id="NmeaParser_Messages_Rmb_RangeToDestination" data-uid="NmeaParser.Messages.Rmb.RangeToDestination">
<a class="xref" href="NmeaParser.Messages.Rmb.RangeToDestination.html#NmeaParser_Messages_Rmb_RangeToDestination">RangeToDestination</a>
</td>
<td class="markdown level1 summary"><p>Range to destination in nautical miles</p>
</td>
</tr>
<tr>
<td id="NmeaParser_Messages_Rmb_Status" data-uid="NmeaParser.Messages.Rmb.Status">
<a class="xref" href="NmeaParser.Messages.Rmb.Status.html#NmeaParser_Messages_Rmb_Status">Status</a>
</td>
<td class="markdown level1 summary"><p>Data Status</p>
</td>
</tr>
<tr>
<td id="NmeaParser_Messages_Rmb_TrueBearing" data-uid="NmeaParser.Messages.Rmb.TrueBearing">
<a class="xref" href="NmeaParser.Messages.Rmb.TrueBearing.html#NmeaParser_Messages_Rmb_TrueBearing">TrueBearing</a>
</td>
<td class="markdown level1 summary"><p>True bearing to destination</p>
</td>
</tr>
<tr>
<td id="NmeaParser_Messages_Rmb_Velocity" data-uid="NmeaParser.Messages.Rmb.Velocity">
<a class="xref" href="NmeaParser.Messages.Rmb.Velocity.html#NmeaParser_Messages_Rmb_Velocity">Velocity</a>
</td>
<td class="markdown level1 summary"><p>Velocity towards destination in knots</p>
</td>
</tr>
</tbody>
</table>
<h3 id="appliesTo">Applies</h3>
<div class="appliesto">
<div>
<table>
<thead><th>Target</th><th>Versions</th></thead>
<tbody>
<tr><td><b>.NET Standard 2.0</b></td><td>main, v3.0, v2.2, v2.1, v2.0</td></tr>
<tr><td><b>.NET</b></td><td>main, v3.0</td></tr>
<tr><td><b>.NET Windows</b></td><td>main, v3.0</td></tr>
<tr><td><b>.NET Android</b></td><td>main, v3.0</td></tr>
<tr><td><b>.NET iOS</b></td><td>main, v3.0</td></tr>
<tr><td><b>.NET Framework</b></td><td>main, v3.0, v2.2, v2.1, v2.0</td></tr>
<tr><td><b>UWP</b></td><td>main, v3.0, v2.2, v2.1, v2.0</td></tr>
<tr><td><b>Xamarin.Android</b></td><td>v2.2, v2.1, v2.0</td></tr>
<tr><td><b>Xamarin.iOS</b></td><td>v2.2, v2.1, v2.0</td></tr>
</tbody>
</table>
</div>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/dotMorten/NmeaParser/blob/main/artifacts/docs/api_overwrites/applies-to-overwrite.md/#L6822" class="contribution-link">Edit this page</a>
</li>
<li>
<a href="https://github.com/dotMorten/NmeaParser/blob/main/src/NmeaParser/Nmea/Rmb.cs/#L31" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In this article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>