AsyncRouteManager Directory Reference

Directories
	dart
	java
	kotlin
	objc
	swift

Detailed Description

This directory contains comprehensive examples demonstrating the usage of AsyncRouteManager across all supported platforms: Dart/Flutter, Java, Kotlin, Objective-C, and Swift.

Overview

AsyncRouteManager is used for managing asynchronous route planning sessions. It provides functionality for creating route sessions, managing route listeners, and handling route updates asynchronously.

Key Components

AsyncRouteManager

The main class for managing asynchronous route planning sessions.

Methods:

• createRouteSession(wayPoint, routeOptions) - Creates a routing session with default graph tag
• createRouteSessionWithTag(wayPoint, routeOptions, tag) - Creates a routing session using a specific graph tag
• cancelRouteSession(session) - Cancels a routing session

AsyncRouteListener

Protocol/interface for receiving route updates and progress notifications.

Methods:

• onRouteChanged(status, currentPath) - Called when a new route is built or rebuilt, includes router status
• onRouteAdvanced(distance, point) - Called when user progresses along the route

RouteStatus

Enumeration of router states:

• MISSING_GRAPH - Router is missing the route graph
• MISSING_POSITION - Router is missing the current position
• MISSING_ROUTE - Router is unable to build route to destination
• MISSING_PROJECTION - Current position is off the route graph
• NEW_ROUTE - Router is ready and has a valid route

RouteSession

Class for managing route listeners and session lifecycle.

Methods:

• addRouteListener(listener) - Adds a route listener to receive updates
• removeRouteListener(listener) - Removes a previously added route listener

RoutePath

Class representing a route path between two points.

Properties:

• length - Total length of the route path in meters
• weight - Total route cost/weight
• nodes - List of route nodes (point, weight, distance, events)

Methods:

• head(advance) - Returns the leading segment of the route
• tail(advance) - Returns the remaining segment of the route

RouteEvent

Class representing a route event (turn, transition, etc.).

Properties:

• type - Event type discriminator
• turnEvent - Payload with turn type and angle
• transitionEntryEvent - Transition start payload (from, to)
• transitionExitEvent - Transition finish payload (from, to)
• targetReachedEvent - Reached target payload (index, point)

RouteEventType

Enumeration of route event types:

• TURN_EVENT - Turn event
• TRANSITION_ENTRY_EVENT - Transition entry event
• TRANSITION_EXIT_EVENT - Transition exit event
• TARGET_REACHED_EVENT - Target reached event

TurnType

Enumeration of turn event variants:

• LEFT_SLIGHT, LEFT_NORMAL, LEFT_SHARP
• RIGHT_SLIGHT, RIGHT_NORMAL, RIGHT_SHARP
• COMPLETE

All examples demonstrate how to get all enum values using the values() method or equivalent platform-specific approach.

RouteOptions

Class for configuring route planning parameters.

Properties:

• smoothRadius - Controls route smoothing (0 = no smoothing)
• maxProjectionDistance - Maximum deviation distance before route rebuild
• maxAdvance - Maximum distance advancement between navigation solutions

LocationPoint

Class representing a point within a location.

Properties:

• point - X and Y coordinates in meters
• locationId - Location identifier
• sublocationId - Sublocation identifier

Point

Class representing 2D coordinates.

Properties:

• x - X coordinate
• y - Y coordinate

Platform-Specific Examples

Dart/Flutter

• File: dart/async_route_manager_example.dart
• Features: Demonstrates async/await patterns, Future handling, and Flutter-specific syntax
• Key Tags:
  • [dart_AsyncRouteManager_createRouteSession]
  • [dart_AsyncRouteListener_onRouteChanged]
  • [dart_RoutePath_getLength]
  • [dart_RouteEventType_values]
  • [dart_RouteStatus_values]

Java

• File: java/AsyncRouteManagerExample.java
• Features: Demonstrates Java threading, exception handling, and object-oriented patterns
• Key Tags:
  • [java_AsyncRouteManager_createRouteSession]
  • [java_AsyncRouteListener_onRouteChanged]
  • [java_RoutePath_getLength]
  • [java_RouteEventType_values]
  • [java_RouteStatus_values]

Kotlin

• File: kotlin/AsyncRouteManagerExample.kt
• Features: Demonstrates Kotlin coroutines, suspend functions, and modern Kotlin syntax
• Key Tags:
  • [kotlin_AsyncRouteManager_createRouteSession]
  • [kotlin_AsyncRouteListener_onRouteChanged]
  • [kotlin_RoutePath_getLength]
  • [kotlin_RouteEventType_values]
  • [kotlin_RouteStatus_values]

Objective-C

• File: objc/AsyncRouteManagerExample.m
• Features: Demonstrates Objective-C protocols, memory management, and iOS patterns
• Key Tags:
  • [objc_AsyncRouteManager_createRouteSession]
  • [objc_AsyncRouteListener_onRouteChanged]
  • [objc_RoutePath_getLength]
  • [objc_RouteEventType_values]
  • [objc_RouteStatus_values]

Swift

• File: swift/AsyncRouteManagerExample.swift
• Features: Demonstrates Swift protocols, optionals, and modern iOS development patterns
• Key Tags:
  • [swift_AsyncRouteManager_createRouteSession]
  • [swift_AsyncRouteListener_onRouteChanged]
  • [swift_RoutePath_getLength]
  • [swift_RouteEventType_values]
  • [swift_RouteStatus_values]

Common Usage Patterns

All examples demonstrate the following common patterns:

1. SDK Initialization - Setting up NavigineSdk and obtaining managers
2. Listener Setup - Creating and configuring AsyncRouteListener
3. Session Creation - Creating route sessions with different options and tags
4. Route Management - Adding/removing listeners and managing session lifecycle
5. Route Analysis - Accessing route properties, nodes, and event payloads
6. Advanced Features - Multiple sessions, different route options, and cleanup

Documentation Tags

Each example includes comprehensive documentation tags that help developers quickly locate specific API usage examples:

• [platform_ClassName_methodName] - For method demonstrations
• [platform_ClassName_propertyName] - For property access
• [platform_ClassName_constructor] - For object creation
• [platform_ClassName_values] - For enum value demonstrations

These tags help developers quickly locate specific API usage examples across all platforms.

Running the Examples

Each platform has its own way of running the examples:

• Dart/Flutter: Run with dart async_route_manager_example.dart
• Java: Compile and run with javac AsyncRouteManagerExample.java && java AsyncRouteManagerExample
• Kotlin: Run with kotlin AsyncRouteManagerExampleKt
• Objective-C: Compile and run with Xcode or command line tools
• Swift: Run with swift AsyncRouteManagerExample.swift

Notes

• All examples use consistent test data (coordinates, location/sublocation IDs, graph tags)
• Examples demonstrate proper resource cleanup and memory management
• Error handling is implemented consistently across all platforms
• Async patterns are handled appropriately for each platform (Future, Thread, coroutines, etc.)