HERE iOS SDK Developer's Guide

<NMAElectronicHorizonDelegate>

Protocol Summary

protocol <NMAElectronicHorizonDelegate>

Derived from: <NSObject>

An interface for responding to electronic horizon events sent by the NMAElectronicHorizon.

Include: NMAKit.framework/headers/NMAElectronicHorizonDelegate.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for <NMAElectronicHorizonDelegate> – <NMAElectronicHorizonDelegate>

[For complete information, see the section Protocol Details]

Instance Method Summary

Table 1. Instance Methods
Instance Method Summary

- @optional (void) electronicHorizon:(nonnull NMAElectronicHorizon *) electronicHorizon didReceiveChildDetached:(nonnull NMAEHPathTree *) parent child:(nonnull NMAEHPathTree *) child

Called every time a path is detached from its parent

- @optional (void) electronicHorizon:(nonnull NMAElectronicHorizon *) electronicHorizon didReceiveLinkAdded:(nonnull NMAEHPathTree *) pathTree link:(nonnull NMAEHLink *) link

Called every time a new link is added to the tree

- @optional (void) electronicHorizon:(nonnull NMAElectronicHorizon *) electronicHorizon didReceiveLinkRemoved:(nonnull NMAEHPathTree *) pathTree link:(nonnull NMAEHLink *) link

Called when a link is removed from the tree

- @optional (void) electronicHorizon:(nonnull NMAElectronicHorizon *) electronicHorizon didReceiveNewPosition:(nonnull NMAEHPosition *) position

Guaranteed to be called after updating electronic horizon when a valid map matched position is available

- @optional (void) electronicHorizon:(nonnull NMAElectronicHorizon *) electronicHorizon didReceivePathAdded:(nonnull NMAEHPathTree *) pathTree

Called every time a new path is added to the tree

- @optional (void) electronicHorizon:(nonnull NMAElectronicHorizon *) electronicHorizon didReceivePathRemoved:(nonnull NMAEHPathTree *) pathTree

Called every time a path is removed from the tree

- @optional (void) electronicHorizonDidReceiveTreeReset:(nonnull NMAElectronicHorizon *) electronicHorizon

Called every time when the tree is reset

Protocol Details

An interface for responding to electronic horizon events sent by the NMAElectronicHorizon.

 

Instance Method Details

- @optional (void) electronicHorizon:(nonnull NMAElectronicHorizon *) electronicHorizon didReceiveChildDetached:(nonnull NMAEHPathTree *) parent child:(nonnull NMAEHPathTree *) child

Called every time a path is detached from its parent.

Note:

The detached child is expected to become the new main path, as the vehicle's position could still be matched on the tree.

Parameters:

  • electronicHorizon

    The NMAElectronicHorizon instance.

  • parent

    The parent path tree.

  • child

    The child path tree.

Called every time a new link is added to the tree.

Parameters:

  • electronicHorizon

    The NMAElectronicHorizon instance.

  • pathTree

    The path to which the link was added.

  • link

    The link which was added.

Called when a link is removed from the tree.

Note:

This is not called when the link was already removed as a result of electronicHorizon:didReceivePathRemoved:.

Parameters:

  • electronicHorizon

    The NMAElectronicHorizon instance.

  • pathTree

    The path from which the link will be removed.

  • link

    The link which will be removed.

- @optional (void) electronicHorizon:(nonnull NMAElectronicHorizon *) electronicHorizon didReceiveNewPosition:(nonnull NMAEHPosition *) position

Guaranteed to be called after updating electronic horizon when a valid map matched position is available.

Parameters:

  • electronicHorizon

    The NMAElectronicHorizon instance.

  • position

    Updated position which contains the most probable path which we are currently on and the offset from its origin or an offroad position otherwise.

- @optional (void) electronicHorizon:(nonnull NMAElectronicHorizon *) electronicHorizon didReceivePathAdded:(nonnull NMAEHPathTree *) pathTree

Called every time a new path is added to the tree.

Parameters:

  • electronicHorizon

    The NMAElectronicHorizon instance.

  • pathTree

    The path which was added.

- @optional (void) electronicHorizon:(nonnull NMAElectronicHorizon *) electronicHorizon didReceivePathRemoved:(nonnull NMAEHPathTree *) pathTree

Called every time a path is removed from the tree.

Note:

No additional events about removing will be fired for children and links of this path.

Parameters:

  • electronicHorizon

    The NMAElectronicHorizon instance.

  • pathTree

    The path which will be removed.

- @optional (void) electronicHorizonDidReceiveTreeReset:(nonnull NMAElectronicHorizon *) electronicHorizon

Called every time when the tree is reset.

Note:

A tree reset occurs when the new position cannot be matched to the expected main path or one of it's side paths. The tree will be rebuilt based on the new position.

Parameters:

  • electronicHorizon

    The NMAElectronicHorizon instance.