mirror of
https://github.com/dotMorten/NmeaParser.git
synced 2026-01-30 12:24:29 +01:00
290 lines
13 KiB
HTML
290 lines
13 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<!--[if IE]><![endif]-->
|
||
|
|
<html>
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
|
|
<title>Class Rte </title>
|
||
|
|
<meta name="viewport" content="width=device-width">
|
||
|
|
<meta name="title" content="Class Rte ">
|
||
|
|
|
||
|
|
<meta name="description" content="Routes">
|
||
|
|
<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.Rte">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h1 id="NmeaParser_Messages_Rte" data-uid="NmeaParser.Messages.Rte" class="text-break">Class Rte</h1>
|
||
|
|
<div class="markdown level0 summary"><p>Routes</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"><a class="xref" href="NmeaParser.Messages.NmeaMultiSentenceMessage.html">NmeaMultiSentenceMessage</a></div>
|
||
|
|
<div class="level3"><span class="xref">Rte</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><<a class="xref" href="NmeaParser.Messages.NmeaMessage.html">NmeaMessage</a>></div>
|
||
|
|
<div><a class="xref" href="NmeaParser.IMultiSentenceMessage.html">IMultiSentenceMessage</a></div>
|
||
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></div>
|
||
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.ienumerable">IEnumerable</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="inheritedMembers">
|
||
|
|
<h5>Inherited Members</h5>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.Messages.NmeaMultiSentenceMessage.ToString.html#NmeaParser_Messages_NmeaMultiSentenceMessage_ToString">NmeaMultiSentenceMessage.ToString()</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.Messages.NmeaMultiSentenceMessage.TalkerId.html#NmeaParser_Messages_NmeaMultiSentenceMessage_TalkerId">NmeaMultiSentenceMessage.TalkerId</a>
|
||
|
|
</div>
|
||
|
|
<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.MessageType.html#NmeaParser_Messages_NmeaMessage_MessageType">NmeaMessage.MessageType</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.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.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_Rte_syntax">Syntax</h5>
|
||
|
|
<div class="codewrapper">
|
||
|
|
<pre><code class="lang-csharp hljs">[NmeaMessageType("--RTE")]
|
||
|
|
public sealed class Rte : NmeaMultiSentenceMessage, IEquatable<NmeaMessage>, IMultiSentenceMessage, IEnumerable<string>, IEnumerable</code></pre>
|
||
|
|
</div>
|
||
|
|
<h5 id="NmeaParser_Messages_Rte_remarks"><strong>Remarks</strong></h5>
|
||
|
|
<div class="markdown level0 remarks"><p>Waypoint identifiers, listed in order with starting waypoint first, for the identified route. Two modes of
|
||
|
|
transmission are provided: 'c' indicates that the complete list of waypoints in the route are being
|
||
|
|
transmitted; 'w' indicates a working route where the first listed waypoint is always the last waypoint
|
||
|
|
that had been reached (FROM), while the second listed waypoint is always the waypoint that the vessel is
|
||
|
|
currently heading for (TO), the remaining list of waypoints represents the remainder of the route.</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_Rte__ctor_System_String_System_String___" data-uid="NmeaParser.Messages.Rte.#ctor(System.String,System.String[])">
|
||
|
|
<a class="xref" href="NmeaParser.Messages.Rte.-ctor.html#NmeaParser_Messages_Rte__ctor_System_String_System_String___">Rte(string, string[])</a>
|
||
|
|
</td>
|
||
|
|
<td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="NmeaParser.Messages.Rte.html">Rte</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_Rte_ListType" data-uid="NmeaParser.Messages.Rte.ListType">
|
||
|
|
<a class="xref" href="NmeaParser.Messages.Rte.ListType.html#NmeaParser_Messages_Rte_ListType">ListType</a>
|
||
|
|
</td>
|
||
|
|
<td class="markdown level1 summary"><p>Gets the type of the list.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td id="NmeaParser_Messages_Rte_RouteId" data-uid="NmeaParser.Messages.Rte.RouteId">
|
||
|
|
<a class="xref" href="NmeaParser.Messages.Rte.RouteId.html#NmeaParser_Messages_Rte_RouteId">RouteId</a>
|
||
|
|
</td>
|
||
|
|
<td class="markdown level1 summary"><p>Gets the route identifier.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td id="NmeaParser_Messages_Rte_Waypoints" data-uid="NmeaParser.Messages.Rte.Waypoints">
|
||
|
|
<a class="xref" href="NmeaParser.Messages.Rte.Waypoints.html#NmeaParser_Messages_Rte_Waypoints">Waypoints</a>
|
||
|
|
</td>
|
||
|
|
<td class="markdown level1 summary"><p>Waypoints</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<h3 id="methods">Methods
|
||
|
|
</h3>
|
||
|
|
<table class="table table-bordered table-condensed">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td id="NmeaParser_Messages_Rte_ParseSentences_NmeaParser_Talker_System_String___" data-uid="NmeaParser.Messages.Rte.ParseSentences(NmeaParser.Talker,System.String[])">
|
||
|
|
<a class="xref" href="NmeaParser.Messages.Rte.ParseSentences.html#NmeaParser_Messages_Rte_ParseSentences_NmeaParser_Talker_System_String___">ParseSentences(Talker, string[])</a>
|
||
|
|
</td>
|
||
|
|
<td class="markdown level1 summary"><p>Parses the messages or any message being appended. False should be returned if it's a message being appended doesn't appear to match what has already been loded.</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/#L7350" class="contribution-link">Edit this page</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="https://github.com/dotMorten/NmeaParser/blob/main/src/NmeaParser/Nmea/Rte.cs/#L32" 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>
|