Class RouteFindingLocation

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

Where a finding is: a point, or a span of the route between two distances from departure.

public sealed record RouteFindingLocation : IEquatable<RouteFindingLocation>

Inheritance

object

RouteFindingLocation

Implements

IEquatable<RouteFindingLocation>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RouteFindingLocation(IReadOnlyList<GeoPosition>, double, double)

Where a finding is: a point, or a span of the route between two distances from departure.

public RouteFindingLocation(IReadOnlyList<GeoPosition> Path, double StartDistanceMeters, double EndDistanceMeters)

Parameters

Path IReadOnlyList<GeoPosition>

One position for a point, or the positions along the span in route order.

StartDistanceMeters double

Distance from departure to the start of the span (equal to EndDistanceMeters for a point).

EndDistanceMeters double

Distance from departure to the end of the span.

Properties

EndDistanceMeters

Distance from departure to the end of the span.

public double EndDistanceMeters { get; init; }

Property Value

double

IsPoint

true when the location is a single point.

public bool IsPoint { get; }

Property Value

bool

Path

One position for a point, or the positions along the span in route order.

public IReadOnlyList<GeoPosition> Path { get; init; }

Property Value

IReadOnlyList<GeoPosition>

StartDistanceMeters

Distance from departure to the start of the span (equal to EndDistanceMeters for a point).

public double StartDistanceMeters { get; init; }

Property Value

double

Methods

Point(GeoPosition, double)

A point location at distanceMeters from departure.

public static RouteFindingLocation Point(GeoPosition position, double distanceMeters)

Parameters

position GeoPosition

The point.

distanceMeters double

Distance from departure.

Returns

RouteFindingLocation

The location.