PhysicalAttributes

public struct PhysicalAttributes : Hashable

Physical attributes of the segment.

Note a road can have more than one attribute at the same time.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

  • Indicates whether the navigable segment is paved. Paved is primarily used for map display and routing by assigning higher penalties to unpaved roads. Paved roads are made of concrete, asphalt, cobblestone or brick. Unpaved roads do not have a solid surface, e.g. are made of gravel, dirt or grass.

    Declaration

    Swift

    public var isDirtRoad: Bool
  • Identifies an enclosed (on all sides) passageway through or under an obstruction. This attribute can be used for display or route guidance.

    Declaration

    Swift

    public var isTunnel: Bool
  • Identifies a structure that allows a road, railway, or walkway to pass over another road, railway, waterway, or valley serving map display and route guidance functionalities. Bridge is published on segments that represent significant bridges and/or overpasses; elevated roads are not published as bridge.

    Declaration

    Swift

    public var isBridge: Bool
  • Private identifies roads that are not maintained by an organization responsible for maintenance of public roads. Allows for unique cartographic representation of roads that restrict public use. May be used to avoid routing through a private road.

    Declaration

    Swift

    public var isPrivate: Bool
  • Indicates if there is a physical structure or painted road marking intended to legally prohibit left turns in right-side driving countries, right turns in left-side driving countries, and U-turns at divided intersections or in the middle of divided segments.

    Declaration

    Swift

    @available(*, deprecated, message: "Will be removed in v4.26.0. Please use `PhysicalAttributes.divider` instead for getting `RoadDivider` and `PhysicalAttributes.isMultiplyDigitized` for getting multiply digitized attribute.")
    public var isDividedRoad: Bool
  • Indicates the presence of a roundabout.

    Declaration

    Swift

    public var isRoundabout: Bool
  • Identifies separately digitised roads, i.e., roads that are digitised with one line per direction of traffic instead of one line per road. It may be flagged on roads when certain physical features (e.g. a walkway, a tram, a bus lane) are located between the separately digitised opposing roadbeds if driver perception remains unchanged.

    Declaration

    Swift

    public var isMultiplyDigitized: Bool
  • Indicates the presence of a road divider.

    Declaration

    Swift

    public var divider: RoadDivider?
  • Identifies a generalised route of a boat ferry for passengers or vehicles over water.

    Declaration

    Swift

    public var isBoatFerry: Bool
  • Identifies a generalised route of a ferry for passengers or vehicles via rail. It is applied on a segment that represent a ferry route for vehicles over rail such as: a route for ferrying passengers over rail, if destination is not accessible by the road network or prohibits the use of automobiles.

    Declaration

    Swift

    public var isRailFerry: Bool
  • Creates a new instance with default values.

    Declaration

    Swift

    public init(isDirtRoad: Bool = false, isTunnel: Bool = false, isBridge: Bool = false, isPrivate: Bool = false, isRoundabout: Bool = false, isMultiplyDigitized: Bool = false, divider: RoadDivider? = nil, isBoatFerry: Bool = false, isRailFerry: Bool = false)
  • Creates a new instance with default values.

    Declaration

    Swift

    @available(*, deprecated)
    public init(isDirtRoad: Bool = false, isTunnel: Bool = false, isBridge: Bool = false, isPrivate: Bool = false, isDividedRoad: Bool = false, isRoundabout: Bool = false, isMultiplyDigitized: Bool = false, divider: RoadDivider? = nil, isBoatFerry: Bool = false, isRailFerry: Bool = false)