Skip to content

Commit 06f6e78

Browse files
petesramekpetesramek
committed
Updated docs for version 1.0
1 parent d68187a commit 06f6e78

19 files changed

+2422
-0
lines changed

‎api-reference/1.0/PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.yml‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
### YamlMime:ApiPage
2+
title: Class AbstractPolylineDecoder<TPolyline, TCoordinate>
3+
body:
4+
- api1: Class AbstractPolylineDecoder<TPolyline, TCoordinate>
5+
id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2
6+
src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/develop/1.0/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L23
7+
metadata:
8+
uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2
9+
commentId: T:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2
10+
- facts:
11+
- name: Namespace
12+
value:
13+
text: PolylineAlgorithm.Abstraction
14+
url: PolylineAlgorithm.Abstraction.html
15+
- name: Assembly
16+
value: PolylineAlgorithm.dll
17+
- markdown: >-
18+
Decodes encoded polyline strings into sequences of geographic coordinates.
19+
20+
Implements the <xref href="PolylineAlgorithm.Abstraction.IPolylineDecoder%602" data-throw-if-not-resolved="false"></xref> interface.
21+
- code: 'public abstract class AbstractPolylineDecoder<TPolyline, TCoordinate> : IPolylineDecoder<TPolyline, TCoordinate>'
22+
- h4: Type Parameters
23+
- parameters:
24+
- name: TPolyline
25+
- name: TCoordinate
26+
- h4: Inheritance
27+
- inheritance:
28+
- text: object
29+
url: https://learn.microsoft.com/dotnet/api/system.object
30+
- text: AbstractPolylineDecoder<TPolyline, TCoordinate>
31+
url: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder-2.html
32+
- h4: Implements
33+
- list:
34+
- text: IPolylineDecoder<TPolyline, TCoordinate>
35+
url: PolylineAlgorithm.Abstraction.IPolylineDecoder-2.html
36+
- h4: Inherited Members
37+
- list:
38+
- text: object.Equals(object)
39+
url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
40+
- text: object.Equals(object, object)
41+
url: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
42+
- text: object.GetHashCode()
43+
url: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
44+
- text: object.GetType()
45+
url: https://learn.microsoft.com/dotnet/api/system.object.gettype
46+
- text: object.MemberwiseClone()
47+
url: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
48+
- text: object.ReferenceEquals(object, object)
49+
url: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
50+
- text: object.ToString()
51+
url: https://learn.microsoft.com/dotnet/api/system.object.tostring
52+
- h2: Remarks
53+
- markdown: This abstract class provides a base implementation for decoding polylines, allowing subclasses to define how to handle specific polyline formats.
54+
- h2: Constructors
55+
- api3: AbstractPolylineDecoder()
56+
id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2__ctor
57+
src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/develop/1.0/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L27
58+
metadata:
59+
uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.#ctor
60+
commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.#ctor
61+
- markdown: Initializes a new instance of the <xref href="PolylineAlgorithm.Abstraction.AbstractPolylineDecoder%602" data-throw-if-not-resolved="false"></xref> class with default encoding options.
62+
- code: protected AbstractPolylineDecoder()
63+
- api3: AbstractPolylineDecoder(PolylineEncodingOptions)
64+
id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2__ctor_PolylineAlgorithm_PolylineEncodingOptions_
65+
src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/develop/1.0/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L39
66+
metadata:
67+
uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.#ctor(PolylineAlgorithm.PolylineEncodingOptions)
68+
commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.#ctor(PolylineAlgorithm.PolylineEncodingOptions)
69+
- markdown: Initializes a new instance of the <xref href="PolylineAlgorithm.Abstraction.AbstractPolylineDecoder%602" data-throw-if-not-resolved="false"></xref> class with the specified encoding options.
70+
- code: protected AbstractPolylineDecoder(PolylineEncodingOptions options)
71+
- h4: Parameters
72+
- parameters:
73+
- name: options
74+
type:
75+
- text: PolylineEncodingOptions
76+
url: PolylineAlgorithm.PolylineEncodingOptions.html
77+
description: The <xref href="PolylineAlgorithm.PolylineEncodingOptions" data-throw-if-not-resolved="false"></xref> to use for encoding operations.
78+
- h4: Exceptions
79+
- parameters:
80+
- type:
81+
- text: ArgumentNullException
82+
url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception
83+
description: Thrown when <code class="paramref">options</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>
84+
- h2: Properties
85+
- api3: Options
86+
id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2_Options
87+
src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/develop/1.0/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L46
88+
metadata:
89+
uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.Options
90+
commentId: P:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.Options
91+
- markdown: Gets the encoding options used by this polyline encoder.
92+
- code: public PolylineEncodingOptions Options { get; }
93+
- h4: Property Value
94+
- parameters:
95+
- type:
96+
- text: PolylineEncodingOptions
97+
url: PolylineAlgorithm.PolylineEncodingOptions.html
98+
- h2: Methods
99+
- api3: CreateCoordinate(double, double)
100+
id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2_CreateCoordinate_System_Double_System_Double_
101+
src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/develop/1.0/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L153
102+
metadata:
103+
uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.CreateCoordinate(System.Double,System.Double)
104+
commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.CreateCoordinate(System.Double,System.Double)
105+
- markdown: Creates a coordinate instance from the given latitude and longitude values.
106+
- code: protected abstract TCoordinate CreateCoordinate(double latitude, double longitude)
107+
- h4: Parameters
108+
- parameters:
109+
- name: latitude
110+
type:
111+
- text: double
112+
url: https://learn.microsoft.com/dotnet/api/system.double
113+
description: The latitude value.
114+
- name: longitude
115+
type:
116+
- text: double
117+
url: https://learn.microsoft.com/dotnet/api/system.double
118+
description: The longitude value.
119+
- h4: Returns
120+
- parameters:
121+
- type:
122+
- TCoordinate
123+
description: A coordinate instance of type <code class="typeparamref">TCoordinate</code>.
124+
- api3: Decode(TPolyline)
125+
id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2_Decode__0_
126+
src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/develop/1.0/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L66
127+
metadata:
128+
uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.Decode(`0)
129+
commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.Decode(`0)
130+
- markdown: Decodes an encoded <code class="typeparamref">TPolyline</code> into a sequence of <code class="typeparamref">TCoordinate</code> instances.
131+
- code: public IEnumerable<TCoordinate> Decode(TPolyline polyline)
132+
- h4: Parameters
133+
- parameters:
134+
- name: polyline
135+
type:
136+
- TPolyline
137+
description: The <code class="typeparamref">TPolyline</code> instance containing the encoded polyline string to decode.
138+
- h4: Returns
139+
- parameters:
140+
- type:
141+
- text: IEnumerable
142+
url: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1
143+
- <
144+
- TCoordinate
145+
- '>'
146+
description: An <xref href="System.Collections.Generic.IEnumerable%601" data-throw-if-not-resolved="false"></xref> of <code class="typeparamref">TCoordinate</code> representing the decoded latitude and longitude pairs.
147+
- h4: Exceptions
148+
- parameters:
149+
- type:
150+
- text: ArgumentNullException
151+
url: https://learn.microsoft.com/dotnet/api/system.argumentnullexception
152+
description: Thrown when <code class="paramref">polyline</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.
153+
- type:
154+
- text: ArgumentException
155+
url: https://learn.microsoft.com/dotnet/api/system.argumentexception
156+
description: Thrown when <code class="paramref">polyline</code> is empty.
157+
- type:
158+
- text: InvalidPolylineException
159+
url: PolylineAlgorithm.InvalidPolylineException.html
160+
description: Thrown when the polyline format is invalid or malformed at a specific position.
161+
- api3: GetReadOnlyMemory(TPolyline)
162+
id: PolylineAlgorithm_Abstraction_AbstractPolylineDecoder_2_GetReadOnlyMemory__0_
163+
src: https://github.com/sramekpete/polyline-algorithm-csharp/blob/develop/1.0/src/PolylineAlgorithm/Abstraction/AbstractPolylineDecoder.cs#L139
164+
metadata:
165+
uid: PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.GetReadOnlyMemory(`0)
166+
commentId: M:PolylineAlgorithm.Abstraction.AbstractPolylineDecoder`2.GetReadOnlyMemory(`0)
167+
- markdown: Converts the provided polyline instance into a <xref href="System.ReadOnlyMemory%601" data-throw-if-not-resolved="false"></xref> for decoding.
168+
- code: protected abstract ReadOnlyMemory<char> GetReadOnlyMemory(TPolyline polyline)
169+
- h4: Parameters
170+
- parameters:
171+
- name: polyline
172+
type:
173+
- TPolyline
174+
description: The <code class="typeparamref">TPolyline</code> instance containing the encoded polyline data to decode.
175+
- h4: Returns
176+
- parameters:
177+
- type:
178+
- text: ReadOnlyMemory
179+
url: https://learn.microsoft.com/dotnet/api/system.readonlymemory-1
180+
- <
181+
- text: char
182+
url: https://learn.microsoft.com/dotnet/api/system.char
183+
- '>'
184+
description: A <xref href="System.ReadOnlyMemory%601" data-throw-if-not-resolved="false"></xref> representing the encoded polyline data.
185+
languageId: csharp
186+
metadata:
187+
description: >-
188+
Decodes encoded polyline strings into sequences of geographic coordinates.
189+
190+
Implements the interface.

0 commit comments

Comments
 (0)