Namespace SpatialNET.Network
Namespaces
Classes
- EdgeRuleBuilder
-
The start of an edge rule (SpatialNET.Network.NetworkRule.ForEdges(System.String,SpatialNET.Network.TypeSet)): which ends, and what to count. Immutable.
- Facet
-
One property that a type is made of, with its own values, for example the voltage level (ADR 0049). The value of a facet means the same under every other facet;
0is reserved for "not set". - InvalidGraphException
-
Thrown when the data of a network cannot be a network (ADR 0049): an edge points to a node that the graph does not return, a weight is missing without a fallback, or a cost is negative,
NaNor infinite. - NetworkAnalysis
-
Searches on a network (ADR 0049), as extension methods on SpatialNET.Network.IGraph`2. They read only the part of the network they visit, in batches, and keep one entry per visited node.
- NetworkPath<TNodeId, TEdgeId>
-
The cheapest way between two nodes, as a sequence of edges (ADR 0049).
- NetworkRule
-
A rule that counts the direct neighbours of an element and compares the count with an allowed range (ADR 0052). Build one with SpatialNET.Network.NetworkRule.ForNodes(System.String,SpatialNET.Network.TypeSet) or SpatialNET.Network.NetworkRule.ForEdges(System.String,SpatialNET.Network.TypeSet), or resolve a SpatialNET.Network.NetworkRuleDefinition with SpatialNET.Network.NetworkRule.FromDefinition(SpatialNET.Network.NetworkRuleDefinition,SpatialNET.Network.TypeRegistry). Immutable and thread-safe; use it for any number of checks (SpatialNET.Network.NetworkValidation).
- NetworkRuleDefinition
-
A rule as a row of plain values, so that the host can keep its rules in a table (ADR 0052). Resolve it with SpatialNET.Network.NetworkRule.FromDefinition(SpatialNET.Network.NetworkRuleDefinition,SpatialNET.Network.TypeRegistry).
- NetworkState<TNodeId, TEdgeId>
-
Deviations from the normal switching state for one or more searches, kept in small sets (ADR 0049): "switch 4711 is open today". The network itself does not change.
- NetworkType
-
A type of nodes or edges as a combination of facet values (ADR 0049).
- NetworkValidation
-
Checks SpatialNET.Network.NetworkRules on an SpatialNET.Network.IGraph`2 (ADR 0052). The methods stream: they read their input in blocks, ask the graph for the nodes and the edges of a block in one batch each, and yield the violations of the block before they read the next one. Pass the elements sorted by shard, so that the neighbours of a block come from the shards that are already in the cache.
- NodeRuleBuilder
-
The start of a node rule (SpatialNET.Network.NetworkRule.ForNodes(System.String,SpatialNET.Network.TypeSet)): what to count.
- RuleCountBuilder
-
The last step of a rule: the allowed range of the count. Each method returns the finished SpatialNET.Network.NetworkRule.
- TraversalOptions<TNodeId, TEdgeId>
-
The options shared by the searches (ADR 0049).
- TypeRegistry
-
The types of a network as facet vectors, built from the host's type table (ADR 0049). Resolves type patterns into SpatialNET.Network.TypeSets. Immutable and thread-safe.
- TypeSet
-
A set of type ids, the result of resolving type patterns once (ADR 0049). Searches and rules compare integers only. Immutable and thread-safe.
- WeightDefinition
-
A weight that a search can use (ADR 0049). The values are on the edges (SpatialNET.Network.GraphEdge`2.Weights); the cost of a path is the sum of the costs of its edges. Units are converted by the host.
Structs
- BuiltEdge<TNodeId, TEdgeId, TSource>
-
An edge as the network builder writes it (ADR 0050).
- BuiltNode<TNodeId, TSource>
-
A node as the network builder writes it (ADR 0050).
- CoincidentNode<TNodeId, TSource>
-
A real node of the host in a group of real nodes within the tolerance of each other (ADR 0054).
- EdgeWeight
-
The value of one weight on an edge, for example ohm per kilometre or a maximum speed (ADR 0049).
- GraphEdge<TNodeId, TEdgeId>
-
An edge of a network as the host returns it (ADR 0049). Parallel edges and loops are allowed.
- GraphNode<TNodeId>
-
A node of a network as the host returns it (ADR 0049).
- PathStep<TNodeId, TEdgeId>
-
One edge of a SpatialNET.Network.NetworkPath`2.
- ReachedNode<TNodeId, TEdgeId>
-
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.
- RuleViolation<TNodeId, TEdgeId>
-
A violation of a SpatialNET.Network.NetworkRule (ADR 0052).
- SinkSupply<TNodeId>
-
The sources that supply a sink (ADR 0051).
- SupplyProgress
-
How far SpatialNET.Network.NetworkAnalysis.Supply``2(SpatialNET.Network.IGraph{``0,``1},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},SpatialNET.Network.TraversalOptions{``0,``1},System.IProgress{SpatialNET.Network.SupplyProgress},System.Threading.CancellationToken) is:
SourcesDoneofSourcesTotalruns. - TraceHit<TNodeId, TEdgeId>
-
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.
- TracedEdge<TNodeId, TEdgeId>
-
An edge a run of SpatialNET.Network.NetworkAnalysis.TraceEdges``2(SpatialNET.Network.IGraph{``0,``1},System.Collections.Generic.IEnumerable{``0},SpatialNET.Network.TraversalOptions{``0,``1},System.Threading.CancellationToken) passed or entered.
Interfaces
- IGraph<TNodeId, TEdgeId>
-
The graph of a network, held and implemented by the host (ADR 0049). The library asks for many ids at once, so that the host can answer each call with one query; the searches are extension methods on this interface (SpatialNET.Network.NetworkAnalysis).
- INetworkState<TNodeId, TEdgeId>
-
The switching state of a network for one search (ADR 0049). The normal state is part of the records; an implementation returns deviations from it. Each method gets the whole record, so a host can decide by type.
- INetworkWriter<TNodeId, TEdgeId, TSource>
-
Where the network builder writes the network, implemented by the host (a database) or by
InMemoryGraph(ADR 0050). All nodes are written before the first edge.
Enums
- EdgeDirection
-
Which way an edge may be walked, relative to its digitizing direction SpatialNET.Network.GraphEdge`2.From → SpatialNET.Network.GraphEdge`2.To (ADR 0049).
- ElementKind
-
Whether something refers to a node or to an edge of a network.
- RuleEndFilter
-
Which ends of an edge a rule looks at.
- RuleSeverity
-
How serious a rule violation is, for the host to sort and to show (ADR 0052).
- RuleSubject
-
What a rule checks: nodes or edges.
- TraceHitKind
-
What a SpatialNET.Network.TraceHit`2 says about its node (ADR 0051).
- WeightKind
-
How the value of a weight and the length of an edge turn into the cost of the edge (ADR 0049).