Table of Contents

Class TraversalOptions<TNodeId, TEdgeId>

Namespace
SpatialNET.Network
Assembly
SpatialNET.Network.dll

The options shared by the searches (ADR 0049).

public sealed record TraversalOptions<TNodeId, TEdgeId> : IEquatable<TraversalOptions<TNodeId, TEdgeId>> where TNodeId : notnull, IEquatable<TNodeId> where TEdgeId : notnull, IEquatable<TEdgeId>

Type Parameters

TNodeId

The host's node id.

TEdgeId

The host's edge id.

Inheritance

Implements

Inherited Members

Properties

EdgeTypes

Only edges of these types are walked; null means every edge. The nodes behind other edges are not loaded, so a filter on the voltage level also keeps the shards of the other level out of the search.

public TypeSet? EdgeTypes { get; init; }

Property Value

TypeSet?

MaxCost

The search ends at this cost; nodes beyond it are not reached. Not negative, +∞ by default.

public double MaxCost { get; init; }

Property Value

double

NodeTypes

Only nodes of these types are entered; null means every node. Untyped helper nodes and the start nodes are always entered.

public TypeSet? NodeTypes { get; init; }

Property Value

TypeSet?

State

Deviations from the normal switching state; null means the normal state.

public INetworkState<TNodeId, TEdgeId>? State { get; init; }

Property Value

INetworkState<TNodeId, TEdgeId>?

Weight

How the cost of an edge is computed; SpatialNET.Network.WeightDefinition.Length by default.

public WeightDefinition Weight { get; init; }

Property Value

WeightDefinition