Table of Contents

Struct TraceHit<TNodeId, TEdgeId>

Namespace
SpatialNET.Network
Assembly
SpatialNET.Network.dll

A node a run of SpatialNET.Network.NetworkAnalysis.Trace``2(SpatialNET.Network.IGraph{``0,``1},System.Collections.Generic.IEnumerable{``0},SpatialNET.Network.TraversalOptions{``0,``1},System.Threading.CancellationToken) reached, once per source that reaches it.

public readonly record struct TraceHit<TNodeId, TEdgeId> : IEquatable<TraceHit<TNodeId, TEdgeId>> where TNodeId : notnull, IEquatable<TNodeId> where TEdgeId : notnull, IEquatable<TEdgeId>

Type Parameters

TNodeId
TEdgeId

Implements

Inherited Members

Constructors

TraceHit(TNodeId, int, TNodeId, double, TEdgeId?, TraceHitKind)

A node a run of SpatialNET.Network.NetworkAnalysis.Trace``2(SpatialNET.Network.IGraph{``0,``1},System.Collections.Generic.IEnumerable{``0},SpatialNET.Network.TraversalOptions{``0,``1},System.Threading.CancellationToken) reached, once per source that reaches it.

public TraceHit(TNodeId Node, int TypeId, TNodeId Source, double Cost, TEdgeId? Via, TraceHitKind Kind)

Parameters

Node TNodeId

The node.

TypeId int

Its type.

Source TNodeId

The source of the run.

Cost double

The cost of the cheapest way from Source, under the chosen weight.

Via TEdgeId?

The edge over which the node was reached first; the default value for the source itself.

Kind TraceHitKind

What the hit is.

Properties

Cost

The cost of the cheapest way from Source, under the chosen weight.

public double Cost { get; init; }

Property Value

double

Kind

What the hit is.

public TraceHitKind Kind { get; init; }

Property Value

TraceHitKind

Node

The node.

public TNodeId Node { get; init; }

Property Value

TNodeId

Source

The source of the run.

public TNodeId Source { get; init; }

Property Value

TNodeId

TypeId

Its type.

public int TypeId { get; init; }

Property Value

int

Via

The edge over which the node was reached first; the default value for the source itself.

public TEdgeId? Via { get; init; }

Property Value

TEdgeId?