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

RoadProperties

class RoadProperties(val numberOfLanes: NumberOfLanes = DEFAULT_NUMBER_OF_LANES, @IntRange(from = 0, to = 7) val functionalRoadClass: Int, 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.

Parameters

numberOfLanes

Number of lanes on the road. Defaults to DEFAULT_NUMBER_OF_LANES.

functionalRoadClass

Functional road class. The value is in the range MIN_FUNCTIONAL_ROAD_CLASS and MAX_FUNCTIONAL_ROAD_CLASS. A value of MIN_FUNCTIONAL_ROAD_CLASS represents the most important functional road class. The higher the value the less important the road class.

roadType

The type of the current road.

roadCondition

Road condition. It describes the surface of the road.

drivingSide

The driving side of the road.

isOverpass

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

isUnderpass

Flag that indicates whether the road is in an underpass: true if in 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 required, false otherwise.

isUrbanArea

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

isComplexIntersection

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

isTunnel

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.

tunnelName

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.

isBridge

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.

bridgeName

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.

Throws

IllegalArgumentException

if the value of numberOfLanes or functionalRoadClass is out of range.

Constructors

RoadProperties

constructor(numberOfLanes: NumberOfLanes = DEFAULT_NUMBER_OF_LANES, @IntRange(from = 0, to = 7) functionalRoadClass: Int, 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)