GeneralRoadElements

public struct GeneralRoadElements : HorizonElement

Describes the general road properties on the horizon element.

Important

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

Lifecycle


                    
                    
                    init(id:pathID:startOffset:endOffset:numLanesDrivingDirection:numLanesOppositeDirection:functionalRoadClass:formOfWay:roadCondition:isRightHandDriving:isTunnel:isBridge:isOverpass:isUnderpass:isDividedRoad:isTransitProhibited:isTollRoad:isUrbanArea:isComplexIntersection:)

Initializes GeneralRoadElements .

Important

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

Declaration

Swift

public init(
    id: Int,
    pathID: Int,
    startOffset: Measurement<UnitLength>,
    endOffset: Measurement<UnitLength>,
    numLanesDrivingDirection: Int?,
    numLanesOppositeDirection: Int?,
    functionalRoadClass: Int,
    formOfWay: FormOfWayType?,
    roadCondition: RoadConditionType?,
    isRightHandDriving: Bool,
    isTunnel: Bool,
    isBridge: Bool,
    isOverpass: Bool,
    isUnderpass: Bool,
    isDividedRoad: Bool,
    isTransitProhibited: Bool,
    isTollRoad: Bool,
    isUrbanArea: Bool,
    isComplexIntersection: Bool
)

Parameters

`id`	Identifier of this element.
`pathID`	Identifier of the path where this element belongs.
`startOffset`	Start offset on the path.
`endOffset`	End offset on the path.
`numLanesDrivingDirection`	Number of lanes on the road in the driving direction or null if the number of lanes is not known. If available, the value is in the range [0..15]. A value of 0 indicates that the vehicle is moving in the wrong direction on a one-way road. A value of 15 means 15 or more lanes. The value comprises both normal and exit lanes.
`numLanesOppositeDirection`	Number of lanes on the road in the opposite direction or null if the number of lanes is not known. If available, the value is in the range [0..15]. A value of 0 indicates that the vehicle is moving on a one-way road. A value of 15 means 15 or more lanes. The value comprises both normal and exit lanes.
`functionalRoadClass`	Functional road class.
`formOfWay`	Form of way. It describes the physical properties of the road.
`roadCondition`	Road condition. It describes the surface of the road.
`isRightHandDriving`	Flag that indicates the driving side: true if right hand driving, false otherwise.
`isTunnel`	Flag that indicates whether the road is in a tunnel: true if in a tunnel, false otherwise.
`isBridge`	Flag that indicates whether the road is on a bridge: true if on a bridge, false otherwise.
`isOverpass`	Flag that indicates whether the road is on an overpass: true if on an overpass, false otherwise.
`isUnderpass`	Flag that indicates whether the road is in an underpass: true if in an underpass, false otherwise.
`isDividedRoad`	Flag that indicates whether the road is divided: true if dual carriage, false if single carriage.
`isTransitProhibited`	Flag that indicates whether transit on the road is prohibited: true if prohibited, false otherwise.
`isTollRoad`	Flag that indicates whether the road requires a toll payment: true if toll is required, false otherwise.
`isUrbanArea`	Flag that indicates whether the road is in a built-up area: true if in a built-up area, false otherwise.
`isComplexIntersection`	Flag that indicates whether the road is part of a complex intersection: true if part of a complex intersection, false otherwise.

Public


                    
                    
                    elementType

Declaration

Swift

public let elementType: HorizonElementType

id
Declaration
Swift

public let id: Int
pathID
Declaration
Swift

public let pathID: Int


                    
                    
                    startOffset

Declaration

Swift

public let startOffset: Measurement<UnitLength>


                    
                    
                    endOffset

Declaration

Swift

public let endOffset: Measurement<UnitLength>

numLanesDrivingDirection
Number of lanes on the road in the driving direction or null if the number of lanes is not known. If available, the value is in the range [0..15]. A value of 0 indicates that the vehicle is moving in the wrong direction on a one-way road. A value of 15 means 15 or more lanes. The value comprises both normal and exit lanes.
Declaration
Swift

public let numLanesDrivingDirection: Int?
numLanesOppositeDirection
Number of lanes on the road in the opposite direction or null if the number of lanes is not known. If available, the value is in the range [0..15]. A value of 0 indicates that the vehicle is moving on a one-way road. A value of 15 means 15 or more lanes. The value comprises both normal and exit lanes.
Declaration
Swift

public let numLanesOppositeDirection: Int?
functionalRoadClass
Functional road class.
Declaration
Swift

public let functionalRoadClass: Int
formOfWay
Form of way. It describes the physical properties of the road.
Declaration
Swift

public let formOfWay: FormOfWayType?
roadCondition
Road condition. It describes the surface of the road.
Declaration
Swift

public let roadCondition: RoadConditionType?
isRightHandDriving
Flag that indicates the driving side: true if right hand driving, false otherwise.
Declaration
Swift

public let isRightHandDriving: Bool
isTunnel
Flag that indicates whether the road is in a tunnel: true if in a tunnel, false otherwise.
Declaration
Swift

public let isTunnel: Bool
isBridge
Flag that indicates whether the road is on a bridge: true if on a bridge, false otherwise.
Declaration
Swift

public let isBridge: Bool
isOverpass
Flag that indicates whether the road is on an overpass: true if on an overpass, false otherwise.
Declaration
Swift

public let isOverpass: Bool
isUnderpass
Flag that indicates whether the road is in an underpass: true if in an underpass, false otherwise.
Declaration
Swift

public let isUnderpass: Bool
isDividedRoad
Flag that indicates whether the road is divided: true if dual carriage, false if single carriage.
Declaration
Swift

public let isDividedRoad: Bool
isTransitProhibited
Flag that indicates whether transit on the road is prohibited: true if prohibited, false otherwise.
Declaration
Swift

public let isTransitProhibited: Bool
isTollRoad
Flag that indicates whether the road requires a toll payment: true if toll is required, false otherwise.
Declaration
Swift

public let isTollRoad: Bool
isUrbanArea
Flag that indicates whether the road is in a built-up area: true if in a built-up area, false otherwise.
Declaration
Swift

public let isUrbanArea: Bool
isComplexIntersection
Flag that indicates whether the road is part of a complex intersection: true if part of a complex intersection, false otherwise.
Declaration
Swift

public let isComplexIntersection: Bool