Table of Contents

Struct ReachedNode<TNodeId, TEdgeId>

Namespace
SpatialNET.Network
Assembly
SpatialNET.Network.dll

A node that SpatialNET.Network.NetworkAnalysis.Reach``2(SpatialNET.Network.IGraph{``0,``1},System.Collections.Generic.IEnumerable{``0},SpatialNET.Network.TraversalOptions{``0,``1},System.Threading.CancellationToken) reached.

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

Type Parameters

TNodeId
TEdgeId

Implements

Inherited Members

Constructors

ReachedNode(TNodeId, int, TNodeId, double, TEdgeId?, bool, bool)

A node that SpatialNET.Network.NetworkAnalysis.Reach``2(SpatialNET.Network.IGraph{``0,``1},System.Collections.Generic.IEnumerable{``0},SpatialNET.Network.TraversalOptions{``0,``1},System.Threading.CancellationToken) reached.

public ReachedNode(TNodeId Node, int TypeId, TNodeId Start, double Cost, TEdgeId? Via, bool IsStart, bool Blocked)

Parameters

Node TNodeId

The node.

TypeId int

Its type.

Start TNodeId

The start node of the cheapest way to it.

Cost double

The cost of that way.

Via TEdgeId?

The edge over which it was reached; the default value for a start node (see IsStart).

IsStart bool

Whether the node is one of the start nodes.

Blocked bool

Whether the node is blocked: reached, but not passed.

Properties

Blocked

Whether the node is blocked: reached, but not passed.

public bool Blocked { get; init; }

Property Value

bool

Cost

The cost of that way.

public double Cost { get; init; }

Property Value

double

IsStart

Whether the node is one of the start nodes.

public bool IsStart { get; init; }

Property Value

bool

Node

The node.

public TNodeId Node { get; init; }

Property Value

TNodeId

Start

The start node of the cheapest way to it.

public TNodeId Start { get; init; }

Property Value

TNodeId

TypeId

Its type.

public int TypeId { get; init; }

Property Value

int

Via

The edge over which it was reached; the default value for a start node (see IsStart).

public TEdgeId? Via { get; init; }

Property Value

TEdgeId?