com.tomtom.sdk.location:location-road/com.tomtom.sdk.location.road/RoadProperties

RoadProperties

class RoadProperties(val numberOfLanes: NumberOfLanes, @IntRange(from = 0, to = 7) functionalRoadClass: Int? = null, val roadType: RoadType? = null, val roadCondition: RoadCondition? = null, val drivingSide: DrivingSide, val isOverpass: Boolean = false, val isUnderpass: Boolean = false, val isDividedRoad: Boolean = false, val isTransitProhibited: Boolean = false, val isTollRoad: Boolean = false, val isUrbanArea: Boolean = false, val isComplexIntersection: Boolean = false, val isTunnel: Boolean = false, val tunnelName: String? = null, val isBridge: Boolean = false, val bridgeName: String? = null)

The properties of the road.

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

Constructors

RoadProperties

constructor(numberOfLanes: NumberOfLanes, @IntRange(from = 0, to = 7) functionalRoadClass: Int? = null, roadType: RoadType? = null, roadCondition: RoadCondition? = null, drivingSide: DrivingSide, isOverpass: Boolean = false, isUnderpass: Boolean = false, isDividedRoad: Boolean = false, isTransitProhibited: Boolean = false, isTollRoad: Boolean = false, isUrbanArea: Boolean = false, isComplexIntersection: Boolean = false, isTunnel: Boolean = false, tunnelName: String? = null, isBridge: Boolean = false, bridgeName: String? = null)

Types

Companion

object Companion

Properties

bridgeName

val bridgeName: String? = null

The name of the bridge or null if not applicable (i.e. isBridge is false) or not available. It is not mutually exclusive with tunnelName.

drivingSide

val drivingSide: DrivingSide

The driving side of the road.

functionalRoadClass

val functionalRoadClass: Int?

The functional road class. It indicates the relative importance of the road in the road network. The lower the value, the more important the road. Regular values are in the range MIN_FUNCTIONAL_ROAD_CLASS to MAX_FUNCTIONAL_ROAD_CLASS. A value equal to MIN_FUNCTIONAL_ROAD_CLASS indicates a road from the most important category. A value equal to MAX_FUNCTIONAL_ROAD_CLASS indicates a road from the least important category.

isBridge

val isBridge: Boolean = false

A flag that indicates whether the road is on a bridge. True if the road is on a bridge, false otherwise. It is not mutually exclusive with isTunnel.

isComplexIntersection

val isComplexIntersection: Boolean = false

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

isDividedRoad

val isDividedRoad: Boolean = false

A flag that indicates whether the road lanes are separated by some type of a physical barrier: true if dual carriage, false if single carriage.

isOverpass

val isOverpass: Boolean = false

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

isTollRoad

val isTollRoad: Boolean = false

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

isTransitProhibited

val isTransitProhibited: Boolean = false

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

isTunnel

val isTunnel: Boolean = false

A flag that indicates whether the road is in a tunnel. True if the road is in a tunnel, false otherwise. It is not mutually exclusive with isBridge.

isUnderpass

val isUnderpass: Boolean = false

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

isUrbanArea

val isUrbanArea: Boolean = false

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

numberOfLanes

val numberOfLanes: NumberOfLanes

The number of lanes on the road.

roadCondition

val roadCondition: RoadCondition? = null

The road condition. It describes the surface of the road.

roadType

val roadType: RoadType? = null

The road type. It indicates the type of the road based on a fine-grained classification of roads according to road purpose.

tunnelName

val tunnelName: String? = null

The name of the tunnel or null if not applicable (i.e. isTunnel is false) or not available. It is not mutually exclusive with bridgeName.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String