GMTSVehicle Class Reference
Overview
Object that contains functional data related to a vehicle.
This data can be profile data, such as the max capacity, or tracking data, such as current trips and location.
Inherits GMTCImmutableData.
Public Member Functions | |
| (instancetype) | - initWithvehicleName:vehicleState:supportedTripTypes:currentTrips:lastLocation:maximumCapacity:attributes:vehicleType: |
| Initialization of the object. | |
Properties | |
| NSString * | vehicleName |
| The name of the vehicle. | |
| GMTSVehicleState | vehicleState |
| The vehicle state, see GMTSVehicleState for all the options. | |
| GMTSVehicleSupportedTripTypes | supportedTripTypes |
| Supported trip types, see GMTSVehicleSupportedTripTypes for all the options. | |
| NSArray< NSString * > * | currentTrips |
| An array contains all the current trip ID. | |
| GMTSVehicleLocation * | lastLocation |
| The last location of the vehicle. | |
| int32_t | maximumCapacity |
| The maximum capacity. | |
| NSArray < GMTSVehicleAttributeKeyValuePair * > * | attributes |
| An array contains all the vehicle attributes. | |
| GMTSVehicleType * | vehicleType |
| The vehicle type information. | |
Member Function Documentation
| - (instancetype) initWithvehicleName: | (nullable NSString *) | vehicleName | |
| vehicleState: | (GMTSVehicleState) | vehicleState | |
| supportedTripTypes: | (GMTSVehicleSupportedTripTypes) | supportedTripTypes | |
| currentTrips: | (nullable NSArray< NSString * > *) | currentTrips | |
| lastLocation: | (nullable GMTSVehicleLocation *) | lastLocation | |
| maximumCapacity: | (int32_t) | maximumCapacity | |
| attributes: | (nullable NSArray< GMTSVehicleAttributeKeyValuePair * > *) | attributes | |
| vehicleType: | (GMTSVehicleType *) | vehicleType | |
Initialization of the object.
- Parameters:
-
vehicleName The name of the vehicle. vehicleState The vehicle state, see GMTSVehicleState for all the options. supportedTripTypes All the supported trip types. currentTrips An array contains all the current trip ID. lastLocation The last location of the vehicle. maximumCapacity The maximum capacity. attributes A dictionary contains all the vehicle attributes. vehicleType The vehicle type information.
Property Documentation
- (NSString*) vehicleName [read, copy] |
The name of the vehicle.
- (GMTSVehicleState) vehicleState [read, assign] |
The vehicle state, see GMTSVehicleState for all the options.
- (GMTSVehicleSupportedTripTypes) supportedTripTypes [read, assign] |
Supported trip types, see GMTSVehicleSupportedTripTypes for all the options.
- (NSArray<NSString *>*) currentTrips [read, copy] |
An array contains all the current trip ID.
- (GMTSVehicleLocation*) lastLocation [read, copy] |
The last location of the vehicle.
- (int32_t) maximumCapacity [read, assign] |
The maximum capacity.
- (NSArray<GMTSVehicleAttributeKeyValuePair *>*) attributes [read, copy] |
An array contains all the vehicle attributes.
- (GMTSVehicleType*) vehicleType [read, copy] |
The vehicle type information.