CountryInformationElement

public struct CountryInformationElement : HorizonElement

Describes the country information on the horizon element.

This structure holds a horizon element with information regarding country. It contains information regarding country and region ISO codes, driving side, speed units and regional speed limits.

To obtain CountryInformationElement horizon elements, the integrator must create an instance of HorizonEngine, register HorizonOptions including elementTypes containing HorizonElementType .countryInformationType with a call to HorizonEngine .registerHorizonOptions, and request a HorizonResult using the previously registered HorizonOptions with a call to HorizonEngine .generateHorizon.

Important

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

Lifecycle


                    
                    
                    init(id:pathID:startOffset:endOffset:countryCode:regionCode:drivingSide:speedUnit:regionalSpeedLimits:)

Initializes instance of CountryInformationElement.

Declaration

Swift

public init(
    id: Int,
    pathID: Int,
    startOffset: Measurement<UnitLength>,
    endOffset: Measurement<UnitLength>,
    countryCode: String,
    regionCode: String,
    drivingSide: DrivingSide,
    speedUnit: UnitSpeed,
    regionalSpeedLimits: [RegionalSpeedLimit]
)

Public

elementType
Type of the element. Used to filter elements by type.
Declaration
Swift

public let elementType: HorizonElementType
id
Identifier of this element.
Declaration
Swift

public let id: Int
pathID
Identifier of the path where this element belongs.
Declaration
Swift

public let pathID: Int
startOffset
Start offset on the path.
Declaration
Swift

public let startOffset: Measurement<UnitLength>


                    
                    
                    endOffset

End offset on the path.

Declaration

Swift

public let endOffset: Measurement<UnitLength>

countryCode
The ISO country code of the current position according to ISO-3166-1 alpha 3 code.
Declaration
Swift

public let countryCode: String
regionCode
The ISO 3166-2 state/province/region code.
Declaration
Swift

public let regionCode: String
drivingSide
Driving side of the country.
Declaration
Swift

public let drivingSide: DrivingSide
speedUnit
Speed units used in the country.
Declaration
Swift

public let speedUnit: UnitSpeed
regionalSpeedLimits
Speed limits defined for this region/state/country.
Declaration
Swift

public let regionalSpeedLimits: [RegionalSpeedLimit]