RoadProperties

public struct RoadProperties : Equatable

RoadProperties provides information about the properties of the road at the current location.

Lifecycle

  • Initializes the LocationContext.RoadProperties instance with the road properties.

    • functionalRoadClass: Indicates the relative importance of the road in the road network. The value is in the range [0..7], with 0 representing the most important functional road class(FRC). The higher the value, the less important the road class.
    • isTunnel: True if the road is a tunnel, so the current location is in a tunnel. False otherwise.
    • isUnderpass: True if the road is an underpass. False otherwise.
    • roadType: The type of the current road.
    • drivingSide: Driving side of the current road.

    Declaration

    Swift

    public init(
    functionalRoadClass: Int?,
    isTunnel: Bool?,
    isUnderpass: Bool?,
    roadType: RoadType? = nil,
    drivingSide: DrivingSide? = nil
) throws

Public

  • Indicates relative importance of the road in the routing network. Lower values mean higher priority. Regular values are in range [0, 7]. 0 is the highest class, 7 the lowest one.

    Declaration

    Swift

    public let functionalRoadClass: Int?

  • True, if the road is a tunnel, false otherwise.

    Declaration

    Swift

    public let isTunnel: Bool?

  • True, if the road is an underpass, false otherwise.

    Declaration

    Swift

    public let isUnderpass: Bool?

  • The type of the road.

    Declaration

    Swift

    public let roadType: RoadType?

  • Driving side of the current road.

    Declaration

    Swift

    public let drivingSide: DrivingSide?