HERE iOS SDK Developer's Guide

NMACLE2CorridorRequest

Class Summary

class NMACLE2CorridorRequest

Derived from: NMACLE2Request

Represents a custom location search request that searches along a route specified by a sequence of coordinates and radius.

Include: NMAKit.framework/headers/NMACLE2CorridorRequest.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMACLE2CorridorRequest

[For complete information, see the section Class Details]

Instance Method Summary

Table 1. Instance Methods
Instance Method Summary

-(nullable instancetype) initWithLayer:(nonnull NSString *) layerId corridor:(nonnull NSArray< NMAGeoCoordinates * > *) coordinatesArray radius:(NSInteger) radius

Creates a Corridor Search Request

-(nullable instancetype) initWithLayer:(nonnull NSString *) layerId route:(nonnull NMARoute *) route radius:(NSInteger) radius

Creates a Corridor Search Request from a given NMARoute

-(nullable instancetype) initWithLayers:(nonnull NSArray< NSString * > *) layerIds corridor:(nonnull NSArray< NMAGeoCoordinates * > *) coordinatesArray radius:(NSInteger) radius

Creates a Corridor Search Request that searches through multiple layers

-(nullable instancetype) initWithLayers:(nonnull NSArray< NSString * > *) layerIds route:(nonnull NMARoute *) route radius:(NSInteger) radius

Creates a Corridor Search Request that searches through multiple layers from a given NMARoute

Class Details

Represents a custom location search request that searches along a route specified by a sequence of coordinates and radius.

A new NMACLE2CorridorRequest should be created for each distinct search.

Instance Method Details

-(nullable instancetype) initWithLayer:(nonnull NSString *) layerId corridor:(nonnull NSArray< NMAGeoCoordinates * > *) coordinatesArray radius:(NSInteger) radius

Creates a Corridor Search Request.

Note:

Returns nil if initialization failed.

Parameters:

  • layerId

    Name of the layer specifying the layer to search.

  • coordinatesArray

    Specify the NMAGeoCoordinates of the polyline used as the search center line.

  • radius

    An NSInteger specifying the search radius in meters. All geometries overlapping the corridor polygon will be returned.

-(nullable instancetype) initWithLayer:(nonnull NSString *) layerId route:(nonnull NMARoute *) route radius:(NSInteger) radius

Creates a Corridor Search Request from a given NMARoute.

Note:

Returns nil if initialization failed.

Parameters:

  • layerId

    Name of the layer specifying the layer to search.

  • route

    Specify the NMARoute to be used as the search center line.

  • radius

    An NSInteger specifying the search radius in meters. All geometries overlapping the corridor polygon will be returned.

-(nullable instancetype) initWithLayers:(nonnull NSArray< NSString * > *) layerIds corridor:(nonnull NSArray< NMAGeoCoordinates * > *) coordinatesArray radius:(NSInteger) radius

Creates a Corridor Search Request that searches through multiple layers.

Note:

Returns nil if initialization failed.

Parameters:

  • layerIds

    An NSArray with names specifying the layers to search.

  • coordinatesArray

    Specify the NMAGeoCoordinates of the polyline used as the search center line.

  • radius

    An NSInteger specifying the search radius in meters.

-(nullable instancetype) initWithLayers:(nonnull NSArray< NSString * > *) layerIds route:(nonnull NMARoute *) route radius:(NSInteger) radius

Creates a Corridor Search Request that searches through multiple layers from a given NMARoute.

Note:

Returns nil if initialization failed.

Parameters:

  • layerIds

    An NSArray with names specifying the layers to search.

  • route

    Specify the NMARoute used as the search center.

  • radius

    An NSInteger specifying the search radius in meters.