overview.md

J4JSoftware.RouteSnapperLib: Overview

RouteSnapperLib is a Net 7 library for using online route snapping services to snap imported geolocation (GPS) data to roads.

It has nullability enabled.

It is copyright 2023 Mark A. Olbert and licensed under the GPL v3.

• Overview
• Snapping Routes
• Configuration via Extension Methods
  • Adding Data Sources
  • Specifying Filters
  • Specifying Outputs
  • Specifying the Snapping Service
  • Logging and Messaging
• Example

Overview

You use RouteSnapperLib by configuring an instance of RouteBuilder and then building it. Here's a diagram illustrating the overall process:

RouteBuilder has only a single public constructor, with a single optional parameter of Microsoft ILoggerFactory:

public RouteBuilder(
    ILoggerFactory? loggerFactory = null
)

return to top

Configuration via Extension Methods

You configure RouteBuilder by calling various extension methods, which fall into several categories. The extension methods all return the instance of RouteBuilder being configured, so you can daisy-chain them in a fluid fashion.

• Adding Data Sources
• Specifying Filters
• Specifying Outputs
• Specifying the Snapping Service
• Logging and Messaging

return to top