TomTom SDK for iOS VehicleRestrictionElement

VehicleRestrictionElement

public struct VehicleRestrictionElement : HorizonElement

HorizonElement that contains data about a vehicle restriction.

To receive such elements in the HorizonSnapshot, specify HorizonElementType.vehicleRestrictionType in the HorizonOptions that you register with the HorizonEngine:

let horizonOptions = HorizonOptions(
    id: UUID(),
    elementTypes: [.vehicleRestrictionType],
    ...
)

  • Type of the element. Used to filter elements by type.

    Declaration

    Swift

    public let elementType: HorizonElementType

  • End offset on the HorizonPath.

    Declaration

    Swift

    public let endOffset: Measurement<UnitLength>
  • id

    The unique ID of the horizon element.

    Declaration

    Swift

    public let id: Int

  • Creates a single instance of a horizon element that specifies vehicle restrictions.

    Declaration

    Swift

    public init(
    id: Int,
    pathID: Int,
    startOffset: Measurement<UnitLength>,
    endOffset: Measurement<UnitLength>,
    restrictions: [RestrictionData]
)

    Parameters

    id

    The unique ID of the horizon element.
    pathID

    The id of the path to which this element belongs.
    startOffset

    Indicates the start offset along the path this data applies to.
    endOffset

    Indicates the end offset along the path this data applies to.
    restrictions

    A list of vehicle restrictions.

  • Identifier of the HorizonPath to which this element belongs.

    Declaration

    Swift

    public let pathID: Int

  • Restricted vehicle types.

    See more

    Declaration

    Swift

    public enum RestrictedVehicleType

  • Data corresponding to a single vehicle restriction.

    See more

    Declaration

    Swift

    public struct RestrictionData : Equatable

  • List of RestrictionData.

    Declaration

    Swift

    public let restrictions: [RestrictionData]

  • Supported vehicle restriction types.

    See more

    Declaration

    Swift

    public enum RestrictionType : Equatable

  • Start offset on the HorizonPath.

    Declaration

    Swift

    public let startOffset: Measurement<UnitLength>