TollgateInstruction
public struct TollgateInstruction : Instruction
Instruction indicating the driver is approaching a tollgate or ETC terminal.
Fine-grained Announcement
s for the Instruction
.
Declaration
Swift
@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public let announcements: [Announcement]
Indicates whether it is possible to combine the instruction with the next one. This can be used to build messages like “Turn left and then turn right”.
Declaration
Swift
@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public let combineWithNext: Bool
Indicates left-hand vs. right-hand side driving at the point of the maneuver.
Declaration
Swift
public let drivingSide: TomTomSDKCommon.DrivingSide
The ID of the instruction.
Declaration
Swift
public let id: UUID
init(tollgateName:paymentTypes:routeOffset:maneuverPoint:drivingSide:combineWithNext:announcements:previousSignificantRoad:nextSignificantRoad:routePath:intersectionName:signpost:landmark:sideStreetOffset:trafficLightOffset:id:)
Initializes the route instruction, specifying values for its fields.
Throws
An error of the typeInitializationError
.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public init(
tollgateName: TextWithPhonetics?,
paymentTypes: Set<TollPaymentType>,
routeOffset: Measurement<UnitLength>,
maneuverPoint: CLLocationCoordinate2D,
drivingSide: TomTomSDKCommon.DrivingSide,
combineWithNext: Bool,
announcements: [Announcement] = [],
previousSignificantRoad: Road? = nil,
nextSignificantRoad: Road? = nil,
routePath: [InstructionPoint] = [],
intersectionName: TextWithPhonetics? = nil,
signpost: Signpost? = nil,
landmark: Landmark? = nil,
sideStreetOffset: Measurement<UnitLength>? = nil,
trafficLightOffset: Measurement<UnitLength>? = nil,
id: UUID = UUID()
) throws
Parameters
tollgateName
|
The name of the tollgate, if any. |
paymentTypes
|
The payment types accepted at the tollgate, if available. |
routeOffset
|
The distance from the start of the route to the instruction point. |
maneuverPoint
|
Location of the maneuver expressed as |
drivingSide
|
Indicates left-hand vs. right-hand side driving at the point of the maneuver. |
combineWithNext
|
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”. |
announcements
|
Fine-grained |
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
|
An array of |
intersectionName
|
Name of the intersection at the maneuver point, if present for this instruction. |
signpost
|
Signpost information, if present for this instruction. |
landmark
|
Landmark information, if present in this instruction. |
sideStreetOffset
|
Distance to the maneuver point from the intermediate side street, if any. |
trafficLightOffset
|
Distance to the maneuver point from the preceding traffic light, if any. |
id
|
The ID of the instruction. |
Errors that can be thrown during creation an instance.
See moreDeclaration
Swift
public enum InitializationError : Error
Name of the intersection at the maneuver point, if present for this instruction.
Declaration
Swift
public let intersectionName: TextWithPhonetics?
Landmark information, if present in this instruction.
Declaration
Swift
public let landmark: Landmark?
Location of the maneuver expressed as 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 RoutePoint
s that represents a route path.
Declaration
Swift
public let routePath: [InstructionPoint]
Distance to the maneuver point from the intermediate side street, if any.
Declaration
Swift
public let sideStreetOffset: Measurement<UnitLength>?
Signpost information, if present for this instruction.
Declaration
Swift
public let signpost: Signpost?
The name of the tollgate.
Declaration
Swift
public let tollgateName: TextWithPhonetics?
Distance to the maneuver point from the preceding traffic light, if any.
Declaration
Swift
public let trafficLightOffset: Measurement<UnitLength>?