TomTomSDKRoute 0.2.3404 Docs

TomTomSDKRoute Reference Road Structure Reference

Road

public struct Road

extension Road: Equatable

Road information at a given point on a Route.

Important

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

Lifecycle


                    
                    
                    init(name:numbers:shields:types:)

Creates the instance with the specified properties.

Throws

If all properties are empty, the error RoadInformationError.missingRoadInfo thrown.

Declaration

Swift

public init(
    name: TextWithPhonetics?,
    numbers: [TextWithPhonetics],
    shields: [RoadShield],
    types: Set<RoadType> = []
) throws

Parameters

`name`	The name of the road.
`numbers`	The road numbers.
`shields`	The road shields.
`types`	Indicates a road types.

Public

name
Text content of the road name.
Declaration
Swift

public let name: TextWithPhonetics?
numbers
The road numbers.
Declaration
Swift

public let numbers: [TextWithPhonetics]
shields
The road shields.
Declaration
Swift

public let shields: [RoadShield]
types
Indicates a road types.
Declaration
Swift

public let types: Set<RoadType>

Road.InitializationError

InitializationError
An error that occurs during the creation of the instance.

Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public enum InitializationError : Error