Show / Hide Table of Contents

Class CompleteRouteBuilder

An algorithm to build a route from a path.

Inheritance
System.Object
AlgorithmBase
CompleteRouteBuilder
Inherited Members
AlgorithmBase.HasRun
AlgorithmBase.HasSucceeded
AlgorithmBase.ErrorMessage
AlgorithmBase.CheckHasRun()
AlgorithmBase.CheckHasRunAndHasSucceeded()
AlgorithmBase.Run()
AlgorithmBase.Run(CancellationToken)
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: System.Dynamic.ExpandoObject
Assembly: cs.temp.dll.dll
Syntax
public class CompleteRouteBuilder : AlgorithmBase, IAlgorithm

Constructors

CompleteRouteBuilder(RouterDb, Profile, RouterPoint, RouterPoint, List<UInt32>)

Creates a router builder.

Declaration
public CompleteRouteBuilder(RouterDb routerDb, Profile profile, RouterPoint source, RouterPoint target, List<uint> path)
Parameters
RouterDb routerDb

Profile profile

RouterPoint source

RouterPoint target

List<System.UInt32> path

Properties

Route

Gets the route.

Declaration
public Route Route { get; }
Property Value
Route

Methods

Build(RouterDb, Profile, RouterPoint, RouterPoint, EdgePath<Single>)

Builds a route.

Declaration
public static Route Build(RouterDb db, Profile profile, RouterPoint source, RouterPoint target, EdgePath<float> path)
Parameters
RouterDb db

Profile profile

RouterPoint source

RouterPoint target

EdgePath<System.Single> path

Returns
Route

Build(RouterDb, Profile, RouterPoint, RouterPoint, EdgePath<Single>, CancellationToken)

Builds a route.

Declaration
public static Route Build(RouterDb db, Profile profile, RouterPoint source, RouterPoint target, EdgePath<float> path, CancellationToken cancellationToken)
Parameters
RouterDb db

Profile profile

RouterPoint source

RouterPoint target

EdgePath<System.Single> path

CancellationToken cancellationToken

Returns
Route

Build(RouterDb, Profile, RouterPoint, RouterPoint, List<UInt32>)

Builds a route.

Declaration
public static Route Build(RouterDb db, Profile profile, RouterPoint source, RouterPoint target, List<uint> path)
Parameters
RouterDb db

Profile profile

RouterPoint source

RouterPoint target

List<System.UInt32> path

Returns
Route

Build(RouterDb, Profile, RouterPoint, RouterPoint, List<UInt32>, CancellationToken)

Builds a route.

Declaration
public static Route Build(RouterDb db, Profile profile, RouterPoint source, RouterPoint target, List<uint> path, CancellationToken cancellationToken)
Parameters
RouterDb db

Profile profile

RouterPoint source

RouterPoint target

List<System.UInt32> path

CancellationToken cancellationToken

Returns
Route

DoRun(CancellationToken)

Executes the actual run of the algorithm.

Declaration
protected override void DoRun(CancellationToken cancellationToken)
Parameters
CancellationToken cancellationToken

Overrides
AlgorithmBase.DoRun(CancellationToken)

TryBuild(RouterDb, Profile, RouterPoint, RouterPoint, List<UInt32>)

Builds a route.

Declaration
public static Result<Route> TryBuild(RouterDb db, Profile profile, RouterPoint source, RouterPoint target, List<uint> path)
Parameters
RouterDb db

Profile profile

RouterPoint source

RouterPoint target

List<System.UInt32> path

Returns
Result<Route>

TryBuild(RouterDb, Profile, RouterPoint, RouterPoint, List<UInt32>, CancellationToken)

Builds a route.

Declaration
public static Result<Route> TryBuild(RouterDb db, Profile profile, RouterPoint source, RouterPoint target, List<uint> path, CancellationToken cancellationToken)
Parameters
RouterDb db

Profile profile

RouterPoint source

RouterPoint target

List<System.UInt32> path

CancellationToken cancellationToken

Returns
Result<Route>

TryBuild<T>(RouterDb, Profile, RouterPoint, RouterPoint, EdgePath<T>)

Builds a route.

Declaration
public static Result<Route> TryBuild<T>(RouterDb db, Profile profile, RouterPoint source, RouterPoint target, EdgePath<T> path)
Parameters
RouterDb db

Profile profile

RouterPoint source

RouterPoint target

EdgePath<T> path

Returns
Result<Route>

Type Parameters
T

TryBuild<T>(RouterDb, Profile, RouterPoint, RouterPoint, EdgePath<T>, CancellationToken)

Builds a route.

Declaration
public static Result<Route> TryBuild<T>(RouterDb db, Profile profile, RouterPoint source, RouterPoint target, EdgePath<T> path, CancellationToken cancellationToken)
Parameters
RouterDb db

Profile profile

RouterPoint source

RouterPoint target

EdgePath<T> path

CancellationToken cancellationToken

Returns
Result<Route>

Type Parameters
T

Back to top Built by Itinero, MIT licensed.