ElectronicHorizon

public class ElectronicHorizon

extension ElectronicHorizon: NativeBase

extension ElectronicHorizon: Hashable

Electronic horizon is responsible for providing the road network ahead of a vehicle. Subscribe to the updates of the electronic horizon path based on the position updates using ElectronicHorizonDelegate. Refer to ElectronicHorizonOptions.lookAheadDistancesInMeters for the configuration of sub path levels.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.


                    
                    
                    init(sdkEngine:options:transportMode:route:)

Creates a new instance of ElectronicHorizon.

Throws

InstantiationError Indicates what went wrong when the instantiation was attempted.

Declaration

Swift

public init(sdkEngine: SDKNativeEngine, options: ElectronicHorizonOptions, transportMode: TransportMode, route: Route?) throws

Parameters

`sdkEngine`	A SDKEngine instance.
`options`	An instance of `ElectronicHorizonOptions` to configure `ElectronicHorizon`.
`transportMode`	Transport mode to be used for the `ElectronicHorizon`.
`route`	Route to improve the calculation of Most preferred path. based on the provided `Route`. If `nil` is passed - Most preferred path could deviate from the route.

route
The instance of Route that is being used by ElectronicHorizon. Can be overridden by the user.
Declaration
Swift

public var route: Route? { get set }


                    
                    
                    update(mapMatchedLocation:)

Updates the electronic horizon paths based on the input location. Update method is not blocking. Callbacks will be called in the main thread when internal calculation is done. During location processing we don’t collect new locations in queue, but keep only last one, so some locations can be skipped.

Declaration

Swift

public func update(mapMatchedLocation: MapMatchedLocation)

Parameters


                                mapMatchedLocation

Map matched location for the update of electronic horizon paths.


                    
                    
                    addElectronicHorizonListener(electronicHorizonListener:)

Adds the ElectronicHorizonDelegate to the subscribtion list.

Declaration

Swift

public func addElectronicHorizonListener(electronicHorizonListener: ElectronicHorizonDelegate)

Parameters


                                electronicHorizonListener

Listener to be added to the electronic horizon paths updates.


                    
                    
                    removeElectronicHorizonListener(electronicHorizonListener:)

Removes the ElectronicHorizonDelegate from the subscribtion list.

Declaration

Swift

public func removeElectronicHorizonListener(electronicHorizonListener: ElectronicHorizonDelegate)

Parameters


                                electronicHorizonListener

Listener to be removed from the electronic horizon paths updates.


                    
                    
                    addElectronicHorizonPositionListener(electronicHorizonPositionListener:)

Adds the ElectronicHorizonPositionDelegate to the subscribtion list.

Declaration

Swift

public func addElectronicHorizonPositionListener(electronicHorizonPositionListener: ElectronicHorizonPositionDelegate)

Parameters


                                electronicHorizonPositionListener

Listener to be added to the electronic horizon position on electronic horizon path updates.


                    
                    
                    removeElectronicHorizonPositionListener(electronicHorizonPositionListener:)

Removes the ElectronicHorizonPositionDelegate from the subscribtion list.

Declaration

Swift

public func removeElectronicHorizonPositionListener(electronicHorizonPositionListener: ElectronicHorizonPositionDelegate)

Parameters


                                electronicHorizonPositionListener

Listener to be removed from the electronic horizon position on electronic horizon path updates.