Class GpxRoute

Represents a route - an ordered list of waypoints representing a series of turn points leading to a destination.

Inheritance

Object

GpxRoute

Inherited Members

Object.Equals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: NetTopologySuite.IO

Assembly: NetTopologySuite.IO.GPX.dll

Syntax

public sealed class GpxRoute

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the complex type "rteType".

Constructors

| Improve this Doc View Source

GpxRoute()

Initializes a new instance of the GpxRoute class.

Declaration

public GpxRoute()

| Improve this Doc View Source

GpxRoute(String, String, String, String, ImmutableArray<GpxWebLink>, Nullable<UInt32>, String, Object, ImmutableGpxWaypointTable)

Initializes a new instance of the GpxRoute class.

Declaration

public GpxRoute(string name, string comment, string description, string source, ImmutableArray<GpxWebLink> links, uint? number, string classification, object extensions, ImmutableGpxWaypointTable waypoints)

Parameters

Type	Name	Description
String	name	The value for Name.
String	comment	The value for Comment.
String	description	The value for Description.
String	source	The value for Source.
ImmutableArray<GpxWebLink>	links	The value for Links.
Nullable<UInt32>	number	The value for Number.
String	classification	The value for Classification.
Object	extensions	The value for Extensions.
ImmutableGpxWaypointTable	waypoints	The value for Waypoints.

Properties

| Improve this Doc View Source

Classification

Gets the classification of the route.

Declaration

public string Classification { get; }

Property Value

Type	Description
String

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "type" element.

| Improve this Doc View Source

Comment

Gets the GPS comment for this route.

Declaration

public string Comment { get; }

Property Value

Type	Description
String

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "cmt" element.

| Improve this Doc View Source

Description

Gets the text description for this route (not sent to GPS).

Declaration

public string Description { get; }

Property Value

Type	Description
String

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "desc" element.

| Improve this Doc View Source

Extensions

Gets arbitrary extension information associated with this route.

Declaration

public object Extensions { get; }

Property Value

Type	Description
Object

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "extensions" element.

| Improve this Doc View Source

Links

Gets links to external information about the route.

Declaration

public ImmutableArray<GpxWebLink> Links { get; }

Property Value

Type	Description
ImmutableArray<GpxWebLink>

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "link" elements.

| Improve this Doc View Source

Name

Get the GPS name of this route.

Declaration

public string Name { get; }

Property Value

Type	Description
String

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "name" element.

| Improve this Doc View Source

Number

Gets the GPS route number.

Declaration

public uint? Number { get; }

Property Value

Type	Description
Nullable<UInt32>

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "number" element.

| Improve this Doc View Source

Source

Gets the source of the data.

Declaration

public string Source { get; }

Property Value

Type	Description
String

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "src" element.

| Improve this Doc View Source

Waypoints

Gets the waypoints that make up this route.

Declaration

public ImmutableGpxWaypointTable Waypoints { get; }

Property Value

Type	Description
ImmutableGpxWaypointTable

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "rtept" elements.

Methods

| Improve this Doc View Source

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

Object.Equals(Object)

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

| Improve this Doc View Source

WithClassification(String)

Builds a new instance of GpxRoute as a copy of this instance, but with Classification replaced by the given value.

Declaration

public GpxRoute WithClassification(string classification)

Parameters

Type	Name	Description
String	classification	The new value for Classification.

Returns

Type	Description
GpxRoute	A new GpxRoute instance that's a copy of the current instance, but with its Classification value set to `classification`.

| Improve this Doc View Source

WithComment(String)

Builds a new instance of GpxRoute as a copy of this instance, but with Comment replaced by the given value.

Declaration

public GpxRoute WithComment(string comment)

Parameters

Type	Name	Description
String	comment	The new value for Comment.

Returns

Type	Description
GpxRoute	A new GpxRoute instance that's a copy of the current instance, but with its Comment value set to `comment`.

| Improve this Doc View Source

WithDescription(String)

Builds a new instance of GpxRoute as a copy of this instance, but with Description replaced by the given value.

Declaration

public GpxRoute WithDescription(string description)

Parameters

Type	Name	Description
String	description	The new value for Description.

Returns

Type	Description
GpxRoute	A new GpxRoute instance that's a copy of the current instance, but with its Description value set to `description`.

| Improve this Doc View Source

WithExtensions(Object)

Builds a new instance of GpxRoute as a copy of this instance, but with Extensions replaced by the given value.

Declaration

public GpxRoute WithExtensions(object extensions)

Parameters

Type	Name	Description
Object	extensions	The new value for Extensions.

Returns

Type	Description
GpxRoute	A new GpxRoute instance that's a copy of the current instance, but with its Extensions value set to `extensions`.

| Improve this Doc View Source

WithLinks(ImmutableArray<GpxWebLink>)

Builds a new instance of GpxRoute as a copy of this instance, but with Links replaced by the given value.

Declaration

public GpxRoute WithLinks(ImmutableArray<GpxWebLink> links)

Parameters

Type	Name	Description
ImmutableArray<GpxWebLink>	links	The new value for Links.

Returns

Type	Description
GpxRoute	A new GpxRoute instance that's a copy of the current instance, but with its Links value set to `links`.

| Improve this Doc View Source

WithName(String)

Builds a new instance of GpxRoute as a copy of this instance, but with Name replaced by the given value.

Declaration

public GpxRoute WithName(string name)

Parameters

Type	Name	Description
String	name	The new value for Name.

Returns

Type	Description
GpxRoute	A new GpxRoute instance that's a copy of the current instance, but with its Name value set to `name`.

| Improve this Doc View Source

WithNumber(Nullable<UInt32>)

Builds a new instance of GpxRoute as a copy of this instance, but with Number replaced by the given value.

Declaration

public GpxRoute WithNumber(uint? number)

Parameters

Type	Name	Description
Nullable<UInt32>	number	The new value for Number.

Returns

Type	Description
GpxRoute	A new GpxRoute instance that's a copy of the current instance, but with its Number value set to `number`.

| Improve this Doc View Source

WithSource(String)

Builds a new instance of GpxRoute as a copy of this instance, but with Source replaced by the given value.

Declaration

public GpxRoute WithSource(string source)

Parameters

Type	Name	Description
String	source	The new value for Source.

Returns

Type	Description
GpxRoute	A new GpxRoute instance that's a copy of the current instance, but with its Source value set to `source`.

| Improve this Doc View Source

WithWaypoints(IEnumerable<GpxWaypoint>)

Builds a new instance of GpxRoute as a copy of this instance, but with Waypoints replaced by the given value.

Declaration

public GpxRoute WithWaypoints(IEnumerable<GpxWaypoint> waypoints)

Parameters

Type	Name	Description
IEnumerable<GpxWaypoint>	waypoints	The new value for Waypoints.

Returns

Type	Description
GpxRoute	A new GpxRoute instance that's a copy of the current instance, but with its Waypoints value set to `waypoints`.

Exceptions

Type	Condition
ArgumentException	Thrown when `waypoints` contains null elements.