HERE iOS SDK Developer's Guide

NMAGeocodeResult

Class Summary

class NMAGeocodeResult

Derived from: NSObject

Represents the result of a geocode request.

Include: NMAKit.framework/headers/NMAGeocodeResult.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAGeocodeResult

[For complete information, see the section Class Details]

See also:

NMAGeocodeRequest

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NMAPlaceLocation location

The location data of the geocode result.

[readable, assign] NSString *  matchLevel

Shows the level of the most precise area information for the match, district, city or a higher administrative level.

[readable, assign] NSDictionary< NSString *, NSNumber * > *  matchQuality

Details about the quality of the result.

[readable, assign] float  relevance

The relevance of the result location to the original search parameters.

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Represents the result of a geocode request.

The data of a geocode result is represented by an instance of NMAPlaceLocation, accessed through the location property. The quality of the result can be assessed in a broad sense with the relevance property, or in more detail using the matchQuality dictionary.

See also:

NMAGeocodeRequest

Public Property Details

[readable, assign] NMAPlaceLocationlocation

The location data of the geocode result.

[readable, assign] NSString * matchLevel

Shows the level of the most precise area information for the match, district, city or a higher administrative level.

The possible values are: "country", "state", "county", "city", "district", "street", "intersection", "houseNumber", "postalCode" and "landmark".

Note:

matchLevel always street for NMAReverseGeocodeModeTrackPosition mode results.

[readable, assign] NSDictionary< NSString *, NSNumber * > * matchQuality

Details about the quality of the result.

Additional information about the accuracy of the result is available in the matchQuality dictionary. It contains one or more NSNumber values representing how well each individual search parameter was matched. The values will be in the range [0, 1] with a value of 1 indicating a perfect match.

The possible keys are "State", "County", "City", "District", "Street", "SecondaryStreet", "HouseNumber", and "PostalCode".

Note:

The "SecondaryStreet" key will be present if an intersection was specified in the geocode request. For example, if the request contained "1st St at 2nd Ave", the "Street" key would access the match value for "1st St" and the "SecondaryStreet" key would access the match value for "2nd Ave".

[readable, assign] float relevance

The relevance of the result location to the original search parameters.

The relevance of a result provides a measure of how accurate or reliable it is. The valid range is [0, 1], with a value of 1 representing a perfect match. If relevancy data is unavailable (such as for an offline search), this property will have the value NMAGeocodeResultInvalidRelevance.

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly