SYGuidedProfile Class Reference

Profile for guided route compute. More...

#import <SYRouteRequest.h>

Inheritance diagram for SYGuidedProfile:
Collaboration diagram for SYGuidedProfile:

Instance Methods

(nonnull instancetype) - initWithPolyline:
 

Properties

NSArray< SYGeoCoordinate * > * polyline
 
NSArray< NSNumber * > * pointPrecisions
 Array of GPS precisions for each point in polyline. Must be the same size as polyline, otherwise will be ignored. Each NSNumber must contain integer value in meters. More...
 
NSArray< NSNumber * > * pointTimestamps
 Array of relative timestamps in milliseconds for each point in polyline. Used for filtering. Timestamps represent relative time of positions as they have appeared (e.g. from GPS signal). Must be the same size as polyline, otherwise will be ignored. Each NSNumber must contain integer value in milliseconds. More...
 
NSArray< NSNumber * > * candidateRanges
 Array containing search area radius for each point, in which road candidates are searched. Must be the same size as polyline, otherwise will be ignored. Each NSNumber must contain integer value in meters. More...
 
SYDistance distanceFilter
 Distance in meters for filtering input polyline. If not 0 - algorithm will skip points in polyline which are closer to the previous point than provided distance. Default is 30 meters. More...
 

Detailed Description

Profile for guided route compute.

Method Documentation

◆ initWithPolyline:

- (nonnull instancetype) initWithPolyline: (nonnull NSArray< SYGeoCoordinate * > *)  polyline

Property Documentation

◆ polyline

- (NSArray<SYGeoCoordinate*>*) polyline
readwritenonatomicstrong

◆ pointPrecisions

- (NSArray<NSNumber*>*) pointPrecisions
readwritenonatomicstrong

Array of GPS precisions for each point in polyline. Must be the same size as polyline, otherwise will be ignored. Each NSNumber must contain integer value in meters.

◆ pointTimestamps

- (NSArray<NSNumber*>*) pointTimestamps
readwritenonatomicstrong

Array of relative timestamps in milliseconds for each point in polyline. Used for filtering. Timestamps represent relative time of positions as they have appeared (e.g. from GPS signal). Must be the same size as polyline, otherwise will be ignored. Each NSNumber must contain integer value in milliseconds.

◆ candidateRanges

- (NSArray<NSNumber*>*) candidateRanges
readwritenonatomicstrong

Array containing search area radius for each point, in which road candidates are searched. Must be the same size as polyline, otherwise will be ignored. Each NSNumber must contain integer value in meters.

◆ distanceFilter

- (SYDistance) distanceFilter
readwritenonatomicassign

Distance in meters for filtering input polyline. If not 0 - algorithm will skip points in polyline which are closer to the previous point than provided distance. Default is 30 meters.


The documentation for this class was generated from the following file: