GMTDVehicleStop Class Reference
Overview
An object representing a vehicle stop for deliveries.
Inherits GMTSImmutableData.
Public Member Functions | |
(instancetype) | - initWithTaskInfoArray:plannedWaypoint:state: |
Instantiates an instance of this class. | |
(instancetype) | - initWithTaskInfoArray:plannedLocation:state: |
Instantiates an instance of this class. | |
Protected Types | |
enum | GMTDVehicleStopState { GMTDVehicleStopStateUnspecified = 0, GMTDVehicleStopStateNew, GMTDVehicleStopStateEnroute, GMTDVehicleStopStateArrived } |
Enum representing all possible VehicleStop states. More... | |
Properties | |
NSArray< GMTSTaskInfo * > * | taskInfoArray |
The array of TaskInfo objects to be performed at this stop. | |
GMSNavigationWaypoint * | plannedWaypoint |
The waypoint for the stop. | |
GMTSLocationInfo * | plannedLocation |
The location of the stop. | |
GMTDVehicleStopState | state |
The current state of a VehicleStop. |
Member Function Documentation
- (instancetype) initWithTaskInfoArray: | (NSArray< GMTSTaskInfo * > *) | taskInfoArray | |
plannedWaypoint: | (nullable GMSNavigationWaypoint *) | plannedWaypoint | |
state: | (GMTDVehicleStopState) | state | |
Instantiates an instance of this class.
- Parameters:
-
taskInfoArray The list of tasks to be performed at this stop. plannedWaypoint The waypoint of the stop. state The state of the VehicleStop.
- (instancetype) initWithTaskInfoArray: | (NSArray< GMTSTaskInfo * > *) | taskInfoArray | |
plannedLocation: | (nullable GMTSLocationInfo *) | plannedLocation | |
state: | (GMTDVehicleStopState) | state | |
Instantiates an instance of this class.
- Parameters:
-
taskInfoArray The list of tasks to be performed at this stop. plannedLocation The location of the stop. state The state of the VehicleStop.
- Note:
- This method is obsolete and will be removed in a future release. Use -initWithTaskInfoArray:plannedWaypoint:state: instead.
Property Documentation
- (NSArray<GMTSTaskInfo *>*) taskInfoArray [read, copy] |
The array of TaskInfo objects to be performed at this stop.
- (GMSNavigationWaypoint*) plannedWaypoint [read, assign] |
The waypoint for the stop.
- (GMTSLocationInfo*) plannedLocation [read, assign] |
The location of the stop.
Note that the locations in the tasks may not exactly match this location, but will be within a short distance.
- Note:
- This property is obsolete and will be removed in a future release. Use the plannedWaypoint property instead.
- (GMTDVehicleStopState) state [read, assign] |
The current state of a VehicleStop.