RoadSignWarning

public struct RoadSignWarning : Hashable

A road sign. The main field describing the sign is RoadSignWarning.type. Some road types are standardized, others can be country specific. A valid road sign contains known RoadSignWarning.type or RoadSignWarning.category. Use RoadSignWarningListener to get notifications with current road signs.

  • id

    Unique identifier for this specific road sign warning instance. Each warning type (truck restrictions, speed warnings, etc.) maintains its own independent ID namespace. Use this ID to track, update, or dismiss individual warning instances of this type.

    Declaration

    Swift

    public var id: Int32

  • Distance to the road sign in meters.

    Declaration

    Swift

    public var distanceToRoadSignInMeters: Double

  • Type of the road sign.

    Declaration

    Swift

    public var type: RoadSignType

  • The main category to which the road sign belongs.

    Declaration

    Swift

    public var category: RoadSignCategory

  • Specifies the general warning to which the road sign belongs.

    Declaration

    Swift

    public var generalWarningType: GeneralWarningRoadSignType

  • Flag indicating if the road sign is a priority sign.

    Declaration

    Swift

    public var isPrioritySign: Bool

  • Specifies a list of vehicle types for which the road sign is applicable. The list will be empty when the road sign is applicable for all vehicles including cars.

    Declaration

    Swift

    public var vehicleTypes: [RoadSignVehicleType]

  • Specifies the weather type for which the sign is applicable. If weather type is WeatherType.unknown, the sign is actual for all weather types.

    Declaration

    Swift

    public var weatherType: WeatherType

  • Optional value visible on the main sign related to specific road sign types, as it is printed on the local road sign.

    Declaration

    Swift

    public var signValue: LocalizedText?

  • Optional pre-warning in terms of distance, of the upcoming warning or regulation. The pre-warning information is given as printed on the local road sign.

    Declaration

    Swift

    public var preWarning: LocalizedText?

  • Optional length information during which the warning is applicable. Usually, this information is shown on a separate shield below the main shield. For example, a sign may warn on playing children for a length of 100 m, starting from the location of the warning sign. The length information (most likely with units) is given as printed on the local road sign.

    Declaration

    Swift

    public var duration: LocalizedText?

  • Optional text visible on the supplemental sign indicating specific time(s) at which the road sign is applicable. The time information is given as printed on the local road sign.

    Declaration

    Swift

    public var validityTime: LocalizedText?

  • The reference to the segment where the road sign is located. It can be used to identify the location of the road sign. It allows to compare the road sign location with the MapMatchedLocation.segment_reference provided by the NavigableLocationListener or with the Span.segmentReference available in the Route’s Span. By combining it with the geometry of the segment, that can be loaded using SegmentDataLoader, it is possible to identify the road sign’s coordinates.

    Declaration

    Swift

    public var roadSignSegment: SegmentReference

  • The distance type for the warning, e.g. a warning for a new road sign ahead or a warning for passing a road sign. Since the road sign warning is given relative to a single position on the route, DistanceType.reached will never be given for this warning.

    Declaration

    Swift

    public var distanceType: DistanceType

  • Creates a new instance.

    Declaration

    Swift

    public init(id: Int32 = 0, distanceToRoadSignInMeters: Double, type: RoadSignType, category: RoadSignCategory, generalWarningType: GeneralWarningRoadSignType, isPrioritySign: Bool, vehicleTypes: [RoadSignVehicleType], weatherType: WeatherType, signValue: LocalizedText? = nil, preWarning: LocalizedText? = nil, duration: LocalizedText? = nil, validityTime: LocalizedText? = nil, roadSignSegment: SegmentReference, distanceType: DistanceType)