GMTSTripWaypoint Class Reference

GMTSTripWaypoint Class Reference

Overview

Object that describes a vehicle stop on its route.

For a trip with multiple passengers, this point might be an intermediate stop or the end of a trip.

Inherits GMTCImmutableData.

Public Member Functions

(instancetype) - initWithLocation:tripID:waypointType:distanceToPreviousWaypointInMeters:ETA:
 Instantiates the object.

Properties

GMTSTerminalLocationlocation
 The location associated with the 'tripWaypoint'.
GMTCFleetEngineIDStringtripID
 The trip ID associated with the waypoint.
GMTSTripWaypointType waypointType
 The type of the trip waypoint.
int32_t distanceToPreviousWaypointInMeters
 The path distance calculated by the Fleet Engine from the previous waypoint on a path to the current waypoint.
NSTimeInterval ETA
 The estimated time of arrival to this waypoint.
NSArray< GMTSLatLng * > * routeFromPreviousWaypoint
 The path calculated by the server from the previous waypoint to the current waypoint encoded as an array of LatLng.
GMTSTrafficDatatrafficData
 The traffic data for the path leading to this waypoint.

Member Function Documentation

- (instancetype) initWithLocation: (nullable GMTSTerminalLocation *)  location
tripID: (nullable GMTCFleetEngineIDString *)  tripID
waypointType: (GMTSTripWaypointType waypointType
distanceToPreviousWaypointInMeters: (int32_t)  distanceToPreviousWaypointInMeters
ETA: (NSTimeInterval)  ETA 

Instantiates the object.

Parameters:
locationThe latitude and longitude associated with the waypoint.
tripIDThe ID of the trip which associated with the waypoint.
waypointTypeThe type of terminal associated with the waypoint.
distanceToPreviousWaypointInMetersThe path distance calculated by Fleet Engine from the previous waypoint to the current waypoint.
ETAThe estimated time of arrival to the waypoint.

Property Documentation

- (GMTSTerminalLocation*) location [read, assign]

The location associated with the 'tripWaypoint'.

- (GMTCFleetEngineIDString*) tripID [read, assign]

The trip ID associated with the waypoint.

- (GMTSTripWaypointType) waypointType [read, assign]

The type of the trip waypoint.

- (int32_t) distanceToPreviousWaypointInMeters [read, assign]

The path distance calculated by the Fleet Engine from the previous waypoint on a path to the current waypoint.

- (NSTimeInterval) ETA [read, assign]

The estimated time of arrival to this waypoint.

- (NSArray<GMTSLatLng *>*) routeFromPreviousWaypoint [read, assign]

The path calculated by the server from the previous waypoint to the current waypoint encoded as an array of LatLng.

- (GMTSTrafficData*) trafficData [read, assign]

The traffic data for the path leading to this waypoint.