Maps SDK for Android/com.magiclane.sdk.routesandnavigation/PTRouteSegment

PTRouteSegment

class PTRouteSegment : GemNativeObj

PTRouteSegment object.

Constructors

constructor(address: Long)

constructor(address: Long, isRef: Boolean)

Properties

val address: Long

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

val agencyFareUrl: String?

Agency Fare URL

val agencyName: String?

Agency Name

val agencyPhone: String?

Agency Phone

val agencyUrl: String?

Agency URL

arrivalDelayInSeconds

val arrivalDelayInSeconds: Int

Arrival Delay in seconds

val arrivalTime: Time?

Arrival Time

val countAlerts: Int

Number of alerts for this PT information.

departureDelayInSeconds

val departureDelayInSeconds: Int

Departure Delay in seconds

val departureTime: Time?

Departure Time

val geographicArea: RectangleGeographicArea?

Geographic area of the route. The geographic area is the smallest rectangle that can be drawn around the route.

val instructions: ArrayList<RouteInstruction>?

Route instructions list.

val lineBlockID: Int

Line Block ID

val lineColor: Rgba?

Line Color

val lineFrom: String?

Line From

val lineTextColor: Rgba?

Line Text Color

val lineTowards: String?

Line Towards

val name: String?

Name

val platformCode: String?

Platform Code

val realtimeStatus: ERealtimeStatus

Realtime Status

val routeUrl: String?

Route URL

val shortName: String?

Short name

val summary: String?

Summary of the route segment.

val timeDistance: TimeDistance?

Length in meters and estimated travel time in seconds for the route / route segment

val transitType: ETransitType

Transit Type

val waypoints: LandmarkList?

List of waypoints. The waypoints are ordered like: departure, first waypoint, ..., destination. Only the route can have intermediate waypoints. The segments have only departure and destination.

Functions

Overrides finalize that garbage collector will call when needed.

external fun getAlert(index: Int): PTAlert?

Get alert specified by index.

hasBicycleSupport

external fun hasBicycleSupport(): Boolean

Has Bicycle Support

external fun hasIncursCosts(): Boolean

Method to check if traveling the route or route segment incurs cost to the user.

hasWheelchairSupport

external fun hasWheelchairSupport(): Boolean

Has Wheelchair Support

external fun isCommon(): Boolean

Check if this segment is of common type.

fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

external fun isSignificant(): Boolean

Return true if this is significant. (worth showing information about it)

external fun isStationWalk(): Boolean

Check if this is a station walk.

operator fun not(): Boolean

Checks if this object is valid.

Releases the native referenced value of this object if:

stayOnSameTransit

external fun stayOnSameTransit(): Boolean

Stay on same Transit