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

GeneralRoadElements

data class GeneralRoadElements( val id: Int, val pathId: Int, val startOffset: Distance, val endOffset: Distance, val numLanesDrivingDirection: Int? = null, val numLanesOppositeDirection: Int? = null, val functionalRoadClass: Int? = null, 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.

Constructors

GeneralRoadElements

fun GeneralRoadElements( id: Int, pathId: Int, startOffset: Distance, endOffset: Distance, numLanesDrivingDirection: Int? = null, numLanesOppositeDirection: Int? = null, functionalRoadClass: Int? = null, 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)

Creates a GeneralRoadElements horizon element.

Types

AdminRoadClassType

@JvmInline

value class AdminRoadClassType

Administrative road class types.

Companion

object Companion

FormOfWayType

@JvmInline

value class FormOfWayType

Form of way types.

RoadConditionType

@JvmInline

value class RoadConditionType

Road pavement condition types.

Properties

adminRoadClass

val adminRoadClass: GeneralRoadElements.AdminRoadClassType? = null

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.

bridge

val bridge: Boolean

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

complexIntersection

val complexIntersection: Boolean

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

dividedRoad

val dividedRoad: Boolean

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

endOffset

open override val endOffset: Distance

formOfWay

val formOfWay: GeneralRoadElements.FormOfWayType? = null

Form of way. It describes the physical properties of the road.

functionalRoadClass

val functionalRoadClass: Int? = null

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.

open override val id: Int

Identifier of this element.

isRightHandDriving

val isRightHandDriving: Boolean

Flag that indicates the driving side: true if right hand driving, false otherwise.

numLanesDrivingDirection

val numLanesDrivingDirection: Int? = null

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

val numLanesOppositeDirection: Int? = null

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.

overpass

val overpass: Boolean

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

pathId

open override val pathId: Int

Identifier of the path this element belongs to.

roadCondition

val roadCondition: GeneralRoadElements.RoadConditionType? = null

Road condition. It describes the surface of the road.

startOffset

open override val startOffset: Distance

Start offset on the path.

tollRoad

val tollRoad: Boolean

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

trail

val trail: Boolean

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

transitProhibited

val transitProhibited: Boolean

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

tunnel

val tunnel: Boolean

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

underpass

val underpass: Boolean

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

urbanArea

val urbanArea: Boolean

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