TomTom SDK for iOS TollgateGuidanceInstruction

TollgateGuidanceInstruction

public struct TollgateGuidanceInstruction : GuidanceInstruction

Guidance instruction indicating the driver is approaching a tollgate or ETC terminal.

  • Indicates if the instruction should be combined with the next one. This can be used to build messages like “Turn left and then turn right”.

    Declaration

    Swift

    public let combinedWithNext: Bool

  • Indicates left-hand vs. right-hand side driving at the point of the maneuver.

    Declaration

    Swift

    public let drivingSide: TomTomSDKCommon.DrivingSide
  • id

    The ID of the instruction.

    Declaration

    Swift

    public let id: UUID

  • Initializes the guidance instruction, specifying values for its fields.

    Throws

    An error of the type InitializationError.

    Declaration

    Swift

    public init(
    tollgateName: String,
    paymentTypes: Set<TollPaymentType>,
    id: UUID,
    routeOffset: Measurement<UnitLength>,
    maneuverPoint: CLLocationCoordinate2D,
    drivingSide: TomTomSDKCommon.DrivingSide,
    combinedWithNext: Bool,
    previousSignificantRoad: Road? = nil,
    nextSignificantRoad: Road? = nil,
    routePath: [InstructionPoint] = [],
    intersectionName: String = "",
    signpost: Signpost? = nil
) throws

    Parameters

    tollgateName

    The name of the tollgate.
    paymentTypes

    The payment types accepted at the tollgate, if available.
    id

    The ID of the instruction.
    routeOffset

    The distance from the start of the route to the instruction point.
    maneuverPoint

    Location of the maneuver expressed as CLLocationCoordinate2D.
    drivingSide

    Indicates left-hand vs. right-hand side driving at the point of the maneuver.
    combinedWithNext

    Indicates whether the instruction should be combined with the next one. This can be used to build messages like “Turn left and then turn right”.
    previousSignificantRoad

    Information about the road the driver will be on immediately before starting the maneuver, if available for this instruction.
    nextSignificantRoad

    Information about the road the driver will be on immediately after completing the maneuver.
    routePath

    A list of RoutePoints that represents a route path.
    intersectionName

    Name of the intersection at the maneuver point, if present for this instruction.
    signpost

    Signpost information, if present for this instruction.

  • Errors that can be thrown during creation an instance.

    See more

    Declaration

    Swift

    public enum InitializationError : Error

  • Name of the intersection at the maneuver point, if present for this instruction.

    Declaration

    Swift

    public let intersectionName: String

  • Location of the maneuver expressed as a CLLocationCoordinate2D.

    Declaration

    Swift

    public let maneuverPoint: CLLocationCoordinate2D

  • Information about the road the driver will be on immediately after completing the maneuver, if available for this instruction.

    Declaration

    Swift

    public let nextSignificantRoad: Road?

  • The payment types accepted at the tollgate, if available.

    Declaration

    Swift

    public let paymentTypes: Set<TollPaymentType>

  • Information about the road the driver will be on immediately before starting the maneuver, if available for this instruction.

    Declaration

    Swift

    public let previousSignificantRoad: Road?

  • The distance from the start of the route to the instruction point.

    Declaration

    Swift

    public let routeOffset: Measurement<UnitLength>

  • An array of InstructionPoint‘s that represents a route path.

    Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public let routePath: [InstructionPoint]

  • Signpost information, if present for this instruction.

    Declaration

    Swift

    public let signpost: Signpost?

  • The name of the tollgate.

    Declaration

    Swift

    public let tollgateName: String