summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h
diff options
context:
space:
mode:
Diffstat (limited to 'SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h')
-rw-r--r--SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h97
1 files changed, 96 insertions, 1 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h
index 10e5affa4..7d1bd2b08 100644
--- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h
+++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleDataResponse.h
@@ -1,6 +1,6 @@
// SDLGetVehicleDataResponse.h
//
-// Copyright (c) 2014 Ford Motor Company. All rights reserved.
+
#import "SDLRPCResponse.h"
@@ -21,30 +21,125 @@
#import "SDLClusterModeStatus.h"
#import "SDLMyKey.h"
+/**
+ * Get Vehicle Data Response is sent, when SDLGetVehicleData has been called
+ *
+ * Since SmartDeviceLink 2.0
+ */
@interface SDLGetVehicleDataResponse : SDLRPCResponse {}
+
+/**
+ * @abstract Constructs a new SDLGetVehicleDataResponse object
+ */
-(id) init;
+
+/**
+ * @abstract Constructs a new SDLGetVehicleDataResponse object indicated by the NSMutableDictionary
+ * parameter
+ * @param dict The NSMutableDictionary to use
+ */
-(id) initWithDictionary:(NSMutableDictionary*) dict;
+
+/**
+ * @abstract A SDLGPSData* value. See GPSData.
+ */
@property(strong) SDLGPSData* gps;
+
+/**
+ * @abstract The vehicle speed in kilometers per hour.
+ */
@property(strong) NSNumber* speed;
+
+/**
+ * @abstract The number of revolutions per minute of the engine.
+ */
@property(strong) NSNumber* rpm;
+
+/**
+ * @abstract The fuel level in the tank (percentage)
+ */
@property(strong) NSNumber* fuelLevel;
+
+/**
+ * @abstract A SDLComponentVolumeStatus* value. The fuel level state.
+ */
@property(strong) SDLComponentVolumeStatus* fuelLevel_State;
+
+/**
+ * @abstract The instantaneous fuel consumption in microlitres.
+ */
@property(strong) NSNumber* instantFuelConsumption;
+
+/**
+ * @abstract The external temperature in degrees celsius.
+ */
@property(strong) NSNumber* externalTemperature;
+
+/**
+ * @abstract The Vehicle Identification Number
+ */
@property(strong) NSString* vin;
+
+/**
+ * @abstract See PRNDL.
+ */
@property(strong) SDLPRNDL* prndl;
+
+/**
+ * @abstract A SDLTireStatus* value. See TireStatus.
+ */
@property(strong) SDLTireStatus* tirePressure;
+
+/**
+ * @abstract Odometer reading in km.
+ */
@property(strong) NSNumber* odometer;
+
+/**
+ * @abstract A SDLBeltStatus* value. The status of the seat belts.
+ */
@property(strong) SDLBeltStatus* beltStatus;
+
+/**
+ * @abstract A SDLBodyInformation* value. The body information including power modes.
+ */
@property(strong) SDLBodyInformation* bodyInformation;
+
+/**
+ * @abstract A SDLDeviceStatus* value. The device status including signal and battery strength.
+ */
@property(strong) SDLDeviceStatus* deviceStatus;
+
+/**
+ * @abstract A SDLVehicleDataResult* value. The status of the brake pedal.
+ */
@property(strong) SDLVehicleDataEventStatus* driverBraking;
+
+/**
+ * @abstract A SDLWiperStatus* value. The status of the wipers.
+ */
@property(strong) SDLWiperStatus* wiperStatus;
+
+/**
+ * @abstract A SDLHeadLampStatus* value. Status of the head lamps.
+ */
@property(strong) SDLHeadLampStatus* headLampStatus;
+
+/**
+ * @abstract Torque value for engine (in Nm) on non-diesel variants.
+ */
@property(strong) NSNumber* engineTorque;
+
+/**
+ * @abstract Accelerator pedal position (percentage depressed)
+ */
@property(strong) NSNumber* accPedalPosition;
+
+/**
+ * @abstract Current angle of the steering wheel (in deg)
+ */
@property(strong) NSNumber* steeringWheelAngle;
@property(strong) SDLECallInfo* eCallInfo;
@property(strong) SDLAirbagStatus* airbagStatus;