HERE iOS SDK Developer's Guide

NMAPlatformDataItem

Class Summary

class NMAPlatformDataItem

Derived from: NSObject, <NSCopying>

After a Platform Data Request run, each layer data is returned with objects of this class.

Include: NMAKit.framework/headers/NMAPlatformDataItem.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAPlatformDataItem

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NSInteger  averageHeightCm

DTM_AVG_HEIGHT data

[readable, assign] NMAPlatformDataConditionType   conditionType

CONDITION_TYPE data

[readable, weak] NSArray< NMAGeoCoordinates * > *  coordinates

LAT & LON data

[readable, assign] NSUInteger  count

The number of entries in the item

[readable, weak] NSString *  linkId

LINK_ID data

[readable, weak] NSArray< NSString * > *  linkIds

LINK_IDS data

[readable, assign] float  linkLengthMeter

LINK_LENGTH data

[readable, assign] NMAPlatformDataVehicleType   vehicleTypes

VEHICLE_TYPES data

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nullable NSArray< NSString * & gt; *) allKeys

Returns all the key strings

-(nullable NSArray< NSString * & gt; *) allValues

Returns the all the value strings

-(void) enumerateKeysAndObjectsUsingBlock:(void)(NSString *_Nonnull key, NSString *_Nonnull obj, BOOL *_Nonnull stop)) block

Applies a given block object to the entries in the item

-(nullable NSDictionary< NSString *, NSString * & gt; *) extract

Extracts the data contained into a dictionary

-(nonnull instancetype) init

Do not directly instantiate an instance of this class

-(nullable NSString *) objectForKeyedSubscript:(nonnull NSString *) key

Returns the data associated with a given key

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

After a Platform Data Request run, each layer data is returned with objects of this class. The properties are just helper shortcuts for the most used fields. That is for any data not accessed via the properties, the users can access them directly. For example, assume item is an object of NMAPlatformDataItem type. Then, item["COUNTRY_ID"] returns the COUNTRY_ID string and nil if the item has no such data.

Public Property Details

[readable, assign] NSInteger averageHeightCm

DTM_AVG_HEIGHT data.

The average height [cm above WGS84 ellipsoid] along the link.

Note:

It is NSIntegerMax if not set.

[readable, assign] NMAPlatformDataConditionType  conditionType

CONDITION_TYPE data.

Type of the condition entity.

Note:

It is NMAPlatformDataConditionTypeUndefined if not set.

See also:

NMAPlatformDataConditionType

[readable, weak] NSArray< NMAGeoCoordinates * > * coordinates

LAT & LON data.

Latitude & longitude coordinates [10^-5 degree WGS84] along the polyline or of the reference node and the non reference node. Comma separated. Each value is relative to the previous.

The LAT & LON strings are converted into an NSArray of NMAGeoCoordinates.

Note:

It is nil if not set.

[readable, assign] NSUInteger count

The number of entries in the item.

[readable, weak] NSString * linkId

LINK_ID data.

Positive 64 bit Integer that globally identifies the road, carto or buildin footprint link, also across map releases. Link IDs are never reused.

However, it is returned as an NString object. It can be converted to numeric value via the [NString longLongValue] method.

Note:

It is nil if not set.

[readable, weak] NSArray< NSString * > * linkIds

LINK_IDS data.

Comma separated list of Permanent link IDs that describe a route path. A negative sign means that this link was driven towards reference node. If the list contains only one link, then a 'B' prefix tells that it applies for both driving directions. Each link ID is a positive 64 bit Integer that globally identifies the road link, also across map releases. Link IDs are never reused.

Note:

It is nil if not set.

[readable, assign] float linkLengthMeter

LINK_LENGTH data.

The link length in meter. This attribute publishes the whole link length, no matter whether the link spans across several tiles. The link length is computed by straight lines between subsequent shape points, no splines or other smoothing functions or geodesic computations are used.

Note:

It is -1.0f if not set.

[readable, assign] NMAPlatformDataVehicleType  vehicleTypes

VEHICLE_TYPES data.

Access Characteristics identify the vehicle types that are allowed on a link, allowed on a lane or to which condition applies.

16 bit bitmask of affected vehicle types or functions. Sum of: Automobiles (1), buses (2), taxis (4), car pools (8), pedestrians (16), trucks (32), deliveries (64), emergency vehicles (128), through traffic (256), motorcycles (512) and road trains (1024).

Note:

It is NMAPlatformDataVehicleTypeUndefined if not set.

See also:

NMAPlatformDataVehicleType

Instance Method Details

-(nullable NSArray< NSString * & gt; *) allKeys

Returns all the key strings.

Returns:

The array of all the keys.

-(nullable NSArray< NSString * & gt; *) allValues

Returns the all the value strings.

Returns:

All the value strings contained in the item.

-(void) enumerateKeysAndObjectsUsingBlock:(void)(NSString *_Nonnull key, NSString *_Nonnull obj, BOOL *_Nonnull stop)) block

Applies a given block object to the entries in the item.

-(nullable NSDictionary< NSString *, NSString * & gt; *) extract

Extracts the data contained into a dictionary.

Returns:

A dictionary of the string key/value pairs.

-(nonnull instancetype) init

Do not directly instantiate an instance of this class.

-(nullable NSString *) objectForKeyedSubscript:(nonnull NSString *) key

Returns the data associated with a given key.

Parameters:

  • key

    The key for the data requested.

Returns:

The associated data or nil if the key isn't found in result.

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly