ExitRoundaboutInstruction Structure Reference


                    
                    
                    announcements

Fine-grained Announcements 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]


                    
                    
                    combineWithNext

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


                    
                    
                    drivingSide

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

Declaration

Swift

public let drivingSide: TomTomSDKCommon.DrivingSide


                    
                    
                    exitNumber

Exit number where the driver should leave the roundabout, counted from the entry point to the roundabout. If the route starts on the roundabout, counting starts from the departure point.

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release. Please use RoundaboutInstruction.exitNumber instead.")
public let exitNumber: Int?

id

The ID of the instruction.

Declaration

Swift

public let id: UUID


                    
                    
                    init(turnAngle:exitNumber:quantizedTurnAngle: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 type InitializationError.

Important

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

Declaration

Swift

public init(
    turnAngle: Measurement<UnitAngle>,
    exitNumber: Int?,
    quantizedTurnAngle: QuantizedTurnAngle,
    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

`turnAngle`	Turn angle relative to the driving direction on the route, in the range `-180...180` degrees.
`exitNumber`	Exit number where the driver should leave the roundabout, counted from the entry point to the roundabout. If the route starts on the roundabout, counting starts from the departure point.
`quantizedTurnAngle`	Classification of the turn angle relative to the driving direction on the entry road to the roundabout.
`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.
`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 `Announcement`s for the `Instruction`.
`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 `RoutePoint`s 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.
`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.


                    
                    
                    InitializationError

Exceptions that can be thrown during creation of RoundaboutInstruction.

Declaration

Swift

public enum InitializationError : Error


                    
                    
                    intersectionName

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

Declaration

Swift

public let intersectionName: TextWithPhonetics?


                    
                    
                    landmark

Landmark information, if present in this instruction.

Declaration

Swift

public let landmark: Landmark?


                    
                    
                    maneuverPoint

Location of the maneuver expressed as CLLocationCoordinate2D.

Declaration

Swift

public let maneuverPoint: CLLocationCoordinate2D


                    
                    
                    nextSignificantRoad

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?


                    
                    
                    previousSignificantRoad

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?


                    
                    
                    quantizedTurnAngle

Classification of the turn angle relative to the driving direction on the entry road to the roundabout, if available.

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release. Please use RoundaboutInstruction.quantizedTurnAngle instead.")
public let quantizedTurnAngle: QuantizedTurnAngle


                    
                    
                    routeOffset

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

Declaration

Swift

public let routeOffset: Measurement<UnitLength>


                    
                    
                    routePath

An array of RoutePoints that represents a route path.

Declaration

Swift

public let routePath: [InstructionPoint]


                    
                    
                    sideStreetOffset

Distance to the maneuver point from the intermediate side street, if any.

Declaration

Swift

public let sideStreetOffset: Measurement<UnitLength>?


                    
                    
                    signpost

Signpost information, if present for this instruction.

Declaration

Swift

public let signpost: Signpost?


                    
                    
                    trafficLightOffset

Distance to the maneuver point from the preceding traffic light, if any.

Declaration

Swift

public let trafficLightOffset: Measurement<UnitLength>?


                    
                    
                    turnAngle

Turn angle relative to the driving direction on the route, in the range -180...180 degrees.

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release. Please use RoundaboutInstruction.turnAngle instead.")
public let turnAngle: Measurement<UnitAngle>