navigation:engine/com.tomtom.sdk.navigation.horizon.elements/GeneralRoadElements

GeneralRoadElements

data class GeneralRoadElements(val id: Int, val pathId: Int, val startOffset: Distance, val endOffset: Distance, val numLanesDrivingDirection: Int, val numLanesOppositeDirection: Int, val functionalRoadClass: Int, val adminRoadClass: GeneralRoadElements.AdminRoadClassType? = null, val formOfWay: GeneralRoadElements.FormOfWayType? = null, val roadCondition: GeneralRoadElements.RoadConditionType? = null, val isRightHandDriving: Boolean, val tunnel: Boolean, val bridge: Boolean, val overpass: Boolean, val underpass: Boolean, val dividedRoad: Boolean, val transitProhibited: Boolean, val tollRoad: Boolean, val urbanArea: Boolean, val complexIntersection: Boolean, val trail: Boolean) : 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.

Parameters

Identifier of this element.

pathId

Identifier of the path this element belongs to.

startOffset

Start offset on the path.

endOffset

End offset on the path.

numLanesDrivingDirection

Number of lanes on the road in the driving direction. 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. 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. The value is in the range 0..7 with 0 representing the most important functional road class. The higher the value the less important the road class.

adminRoadClass

Administrative road class. The value is in the range 0..7 with 0 representing the most important administrative road class. The higher the value the less important the 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.

tunnel

Flag that indicates whether the road is in a tunnel: true if in tunnel, false otherwise.

bridge

Flag that indicates whether the road is on a bridge: true if on bridge, false otherwise.

overpass

Flag that indicates whether the road is on an overpass: true if on overpass, false otherwise.

underpass

Flag that indicates whether the road is in an underpass: true if in underpass, false otherwise.

dividedRoad

Flag that indicates whether the road is divided: true if dual carriage, false if single carriage.

transitProhibited

Flag that indicates whether transit on the road is prohibited: true if prohibited, false otherwise.

tollRoad

Flag that indicates whether the road requires a toll payment: true if toll required, false otherwise.

urbanArea

Flag that indicates whether the road is in a built up area: true if built up area, false otherwise.

complexIntersection

Flag that indicates whether the road is part of a complex intersection: true if complex intersection, false otherwise.

trail

Flag that indicates whether the road is a trail road: true if trail road, false otherwise.

Constructors

GeneralRoadElements

fun GeneralRoadElements(id: Int, pathId: Int, startOffset: Distance, endOffset: Distance, numLanesDrivingDirection: Int, numLanesOppositeDirection: Int, functionalRoadClass: Int, adminRoadClass: GeneralRoadElements.AdminRoadClassType? = null, formOfWay: GeneralRoadElements.FormOfWayType? = null, roadCondition: GeneralRoadElements.RoadConditionType? = null, isRightHandDriving: Boolean, tunnel: Boolean, bridge: Boolean, overpass: Boolean, underpass: Boolean, dividedRoad: Boolean, transitProhibited: Boolean, tollRoad: Boolean, urbanArea: Boolean, complexIntersection: Boolean, trail: Boolean)