Route | iOS SDK | 2GIS Documentation
iOS SDK
Maps
Search
Navigation
Urbi Pro
CityLens
On‑Premise
Account

Route

Describes a route. A route is a set of attributes, each of which is a container of type RouteAttribute or RouteLongAttribute that stores route attribute elements. Route attributes are classified into point attributes and extended attributes. Point attributes (e.g., geometry points or speed bumps) are specified as a pair of a RoutePoint and an attribute value. Extended attributes (such as roadway widths or speed limits) are specified as a pair of a RoutePoint that indicates the start of the attribute and an attribute value. A terminator is placed at the end of the route. For example, if the width of the roadway is specified as a set of pairs {{0m, 3m}, {10m, 7m}, {20m, 5m}, {30m, 0m}}, then for the first 10 meters of the route the roadway is 3 meters wide; at the interval [10m., 20m.) the width is 7 meters; from 20m to the end of the route - 5 meters.

Extends: Hashable
public static func == (lhs: Route, rhs: Route) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by passing them to the given hasher.

Parameters
hasher
Hasher

Hasher to use when combining the components of this instance.

Properties
var geometry

Route geometry.
The RoutePoint of geometry points is not guaranteed to match the RoutePoint of other attribute elements. To calculate the geographic coordinate of an attribute element, you do not need to search the geometry for an element whose RoutePoint matches the RoutePoint of the attribute element. Use the calculate_geo_point function instead.

var instructions

Instructions that must be followed to move along the route.

var intermediatePoints

Intermediate points of a route. The route may not pass directly through an intermediate point, but next to it. The attribute value stores the coordinate where the intermediate point was set, the key stores the coordinate of the projection of the intermediate point on the route.

var altitudes

Elevations on the route.

var badRoads

Bad road (there are bumps and potholes on the road that prevent passage).

var obstacles

Obstacles on a route.

var roadNames

Names of roads/streets.

var settlements

Indication that a section of the route passes through a populated area.

var transportTypes

Mode of transport for which a section of the route is built.

var cameras

Road cameras.

var carriagewaysWidth

Width of the roadway in meters. 0 - width unknown.

var exitSigns
var humps

Artificial bumps.

var lanes
var levels
var maxSpeedLimits

Maximum permissible speed limits.
0 - speed limit is unknown.

var roadRules
var roadSubtypes

Additional description to the type of road on which the route runs.

var roadSurfaces
var roadTypes

Type of road the route takes.

var tolls

Sections of the route on toll roads.

var truckData

Indication of the presence or absence of data for freight navigation.

var truckPassZoneIds

Passing zones for trucks.

var truckRestrictedAreas

Indication of the validity of the no-traffic sign.

var vehicleRestrictedAreas

Indication of a sign prohibiting the passage of any motor vehicle (overlap).

var publicTransportTransfers

Description of how to travel by public transport between transfer points.