HERE iOS SDK Developer's Guide

NMAUrbanMobilityRouteResult

Class Summary

class NMAUrbanMobilityRouteResult

Derived from: NSObject

The Urban Mobility Route Result containing a result for a query.

Include: NMAKit.framework/headers/NMAUrbanMobilityRouteResult.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAUrbanMobilityRouteResult

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NSArray< NMAUrbanMobilityAlert * > *  alerts

Get alerts and disruptions associated with all calculated routes

[readable, assign] NSString *  errorMessage

Gets error message string

[readable, assign] NSArray< NMAUrbanMobilityLink * > *  operatorDisclaimers

Array of associated NMAUrbanMobilityLink

[readable, assign] NSArray< NMAUrbanMobilityOperator * > *  operators

Array of NMAUrbanMobilityOperator which helped supply all calculated routes

[readable, assign] NSArray< NMARoute * > *  routes

Array of possible NMAUrbanMobilityRoute

[readable, assign] BOOL  subsequentRouteSupported

Indicates if it's possible to calculate subsequent route for given result

[readable, assign] NMAUrbanMobilityViolatedOption   violatedOptions

Gets the violated options

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

The Urban Mobility Route Result containing a result for a query. Array of NMAUrbanMobilityOperator, NMAUrbanMobilityLink are related to calculated array of NMAUrbanMobilityRoute.

IMPORTANT: Urban Mobility routing is a Beta feature. The related classes are subject to change without notice.

Public Property Details

[readable, assign] NSArray< NMAUrbanMobilityAlert * > * alerts

[readable, assign] NSString * errorMessage

Gets error message string.

[readable, assign] NSArray< NMAUrbanMobilityLink * > * operatorDisclaimers

Array of associated NMAUrbanMobilityLink. It's a array of NMAUrbanMobilityLink that are available for all calculated routes. To find the disclaimers for a particular NMAUrbanMobilityRouteSection, please see NMAUrbanMobilityRoute::sections::operatorDisclaimers.

[readable, assign] NSArray< NMAUrbanMobilityOperator * > * operators

Array of NMAUrbanMobilityOperator which helped supply all calculated routes. It's common array of unique NMAUrbanMobilityOperator that supply public transport for all calculated routes. To find the operator for a particular NMAUrbanMobilityRoute, please see NMAUrbanMobilityDeparture::NMAUrbanMobilityLine::transitOperator.

[readable, assign] NSArray< NMARoute * > * routes

Array of possible NMAUrbanMobilityRoute.

[readable, assign] BOOL subsequentRouteSupported

Indicates if it's possible to calculate subsequent route for given result. Return YES if result can be used to calculate subsequent routes, NO otherwise.

/see NMAUrbanMobilityRouter.

[readable, assign] NMAUrbanMobilityViolatedOption  violatedOptions

Gets the violated options.

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