Core/com.benomad.msdk.core.geocoding/GeoMapMatchedPoint

GeoMapMatchedPoint

class GeoMapMatchedPoint : GeoRoadLocation

Encapsulates the result of a Map-Matching operation See roadMatch

Since

1.3.0 A significant change related to the Street/House Numbers management was done. Now, getOddStreetNum() and getEvenStreetNum() accessors are deprecated. They have been respectively replaced by getLeftHN() and getRightHN() methods which return the Left and Right House Numbers (Left and right sides are related to the geometric description of the associated polyline).In France, the Left House Number is almost always an odd value but this is not the case in other countries ! In addition, this class provides two new accessors : getLeftPC() and getRightPC() These new methods allow you to get respectively the Left and Right Postal Codes which might be attached to a road. In most cases, these values are identical (Then in this case, only the getLeftPC() returns a value). getSide() is now deprecated (see getRoadSide)

Properties

address

open var address: Long

isoCountryCode

open val isoCountryCode: String

leftHN

open val leftHN: Int

leftPC

open val leftPC: String

maxSpeed

open val maxSpeed: Int

name

open val name: String

networkData

open val networkData: NetworkData

rightHN

open val rightHN: Int

rightPC

open val rightPC: String

ROAD_SIDE_LEFT

val ROAD_SIDE_LEFT: Int = -1

Defines the Left side of a road segment

ROAD_SIDE_RIGHT

val ROAD_SIDE_RIGHT: Int = 1

Defines the Right side of a road segment

ROAD_SIDE_UNDEF

val ROAD_SIDE_UNDEF: Int = 0

Defines an undefined side of a road segment

Functions

dispose

open fun dispose()

Call this method if you want to dispose immediately all underlying native resources.

getAngle

open fun getAngle(): Int

Returns angle of the road segment.

getClassId

open fun getClassId(): Long

Returns the class ID of the road segment.

getConfidenceValue

open fun getConfidenceValue(): Double

Returns a value of confidence on result in range [0, 1].

getGeoPoint

open fun getGeoPoint(): GeoPoint

Returns the geographical position of this road location.

getLeftGeoPath

open fun getLeftGeoPath(): Array<GeoAdminArea>

Returns an optionnal array of GeoAdminArea objects that represents the left administrative hierarchical path of which this map-matched point belongs to.

getObjectId

open fun getObjectId(): ObjectId

Return the internal identifier of the segment of road.

getRightGeoPath

open fun getRightGeoPath(): Array<GeoAdminArea>

Returns an optionnal array of GeoAdminArea objects that represents the right administrative hierarchical path of which this map-matched point belongs to.

getRoadSide

open fun getRoadSide(): Int

Returns the side of the road the location is.

getRouteNumber

open fun getRouteNumber(): String

Returns the Route Number of the road (if any).

getUrbanAreaType

open fun getUrbanAreaType(): Byte

Returns the urban area type this point is in (assuming argument checkUrbanArea was set to true in call to roadMatch).

isWaypoint

open fun isWaypoint(): Boolean

Returns true if this Road Location is a waypoint.