HERE iOS SDK Developer's Guide

NMAEHPathTree

Class Summary

class NMAEHPathTree

Derived from: NSObject

Represents a tree like structure where each PathTree may contain multiple links, parent and children paths.

Include: NMAKit.framework/headers/NMAEHPathTree.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAEHPathTree

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NMAEHPathTreeRange children

The children property is an enumerator of type NMAEHPathTreeRange, which allows to iterate over all children

[readable, assign] NMAEHLinkRange links

The links property is an enumerator of type NMAEHLinkRange, which allows to iterate over all links

[readable, assign] NSUInteger  offsetCentimeters

Returns the distance from the beginning of the parent NMAEHPathTree to the start of this path

[readable, assign] NMAEHPathTree parent

The parent property represents the parent path tree in the hierarchy

[readable, assign] float  probability

Represents the probability of taking this path ranging from 0 to 1

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

Instances of this class should not be initialized

-(BOOL) isEqualToPathTree:(nonnull NMAEHPathTree *) pathTree

Determines whether this NMAEHPathTree is equal to another

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Instances of this class should not be initialized directly

Class Details

Represents a tree like structure where each PathTree may contain multiple links, parent and children paths. For a vehicle, children paths are less likely to be followed than their parents.

Public Property Details

[readable, assign] NMAEHPathTreeRangechildren

The children property is an enumerator of type NMAEHPathTreeRange, which allows to iterate over all children.

The links property is an enumerator of type NMAEHLinkRange, which allows to iterate over all links.

[readable, assign] NSUInteger offsetCentimeters

Returns the distance from the beginning of the parent NMAEHPathTree to the start of this path.

[readable, assign] NMAEHPathTreeparent

The parent property represents the parent path tree in the hierarchy.

Note:

the parent property of the root path tree is nil.

[readable, assign] float probability

Represents the probability of taking this path ranging from 0 to 1.

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized. Call class methods only.

-(BOOL) isEqualToPathTree:(nonnull NMAEHPathTree *) pathTree

Determines whether this NMAEHPathTree is equal to another.

Returns:

YES if the paths are equal, NO otherwise

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly.