summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h
diff options
context:
space:
mode:
Diffstat (limited to 'SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h')
-rw-r--r--SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h105
1 files changed, 103 insertions, 2 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h
index b0ef2fd40..588858d31 100644
--- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h
+++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLGetVehicleData.h
@@ -1,34 +1,135 @@
// SDLGetVehicleData.h
//
-// Copyright (c) 2014 Ford Motor Company. All rights reserved.
+
#import "SDLRPCRequest.h"
+/**
+ * Requests surrent values of specific published vehicle data items.
+ * <p>
+ * Function Group: Location, VehicleInfo and DrivingChara
+ * <p>
+ * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
+ * </p>
+ *
+ * Since SmartDeviceLink 2.0<br/>
+ * See SDLSubscribeVehicleData SDLUnsubscribeVehicleData
+ */
@interface SDLGetVehicleData : SDLRPCRequest {}
+/**
+ * @abstract Constructs a new SDLGetVehicleData object
+ */
-(id) init;
+
+/**
+ * @abstract Constructs a new SDLGetVehicleData object indicated by the NSMutableDictionary
+ * parameter
+ * @param dict The NSMutableDictionary to use
+ */
-(id) initWithDictionary:(NSMutableDictionary*) dict;
+/**
+ * @abstract A boolean value. If true, requests Gps data
+ */
@property(strong) NSNumber* gps;
+
+/**
+ * @abstract A boolean value. If true, requests speed data
+ */
@property(strong) NSNumber* speed;
+
+/**
+ * @abstract A boolean value. If true, requests rpm data
+ */
@property(strong) NSNumber* rpm;
+
+/**
+ * @abstract A boolean value. If true, requests FuelLevel data
+ */
@property(strong) NSNumber* fuelLevel;
+
+/**
+ * @abstract A boolean value. If true, requests fuelLevel_State data
+ */
@property(strong) NSNumber* fuelLevel_State;
+
+/**
+ * @abstract A boolean value. If true, requests instantFuelConsumption data
+ */
@property(strong) NSNumber* instantFuelConsumption;
+
+/**
+ * @abstract A boolean value. If true, requests externalTemperature data
+ */
@property(strong) NSNumber* externalTemperature;
+
+/**
+ * @abstract A boolean value. If true, requests Vehicle Identification Number
+ */
@property(strong) NSNumber* vin;
+
+/**
+ * @abstract A boolean value. If true, requests Currently selected gear data
+ */
@property(strong) NSNumber* prndl;
+
+/**
+ * @abstract A boolean value. If true, requests tire pressure status data
+ */
@property(strong) NSNumber* tirePressure;
+
+/**
+ * @abstract A boolean value. If true, requests odometer data
+ */
@property(strong) NSNumber* odometer;
+
+/**
+ * @abstract A boolean value. If true, requests belt Status data
+ */
@property(strong) NSNumber* beltStatus;
+
+/**
+ * @abstract A boolean value. If true, requests body Information data
+ */
@property(strong) NSNumber* bodyInformation;
+
+/**
+ * @abstract A boolean value. If true, requests device Status data
+ */
@property(strong) NSNumber* deviceStatus;
+
+/**
+ * @abstract A boolean value. If true, requests driver Braking data
+ */
@property(strong) NSNumber* driverBraking;
+
+/**
+ * @abstract A boolean value. If true, requests wiper Status data
+ */
@property(strong) NSNumber* wiperStatus;
+
+/**
+ * @abstract A boolean value. If true, requests Head Lamp Status data
+ */
@property(strong) NSNumber* headLampStatus;
+
+/**
+ * @abstract A boolean value. If true, requests Engine Torque data
+ */
@property(strong) NSNumber* engineTorque;
+
+/**
+ * @abstract A boolean value. If true, means the accPedalPosition data has been
+ * subscribed.
+ */
@property(strong) NSNumber* accPedalPosition;
+
+/**
+ * @abstract A boolean value. If true, means the steeringWheelAngle data has been
+ * subscribed.
+ */
@property(strong) NSNumber* steeringWheelAngle;
@property(strong) NSNumber* eCallInfo;
@property(strong) NSNumber* airbagStatus;
@@ -36,4 +137,4 @@
@property(strong) NSNumber* clusterModeStatus;
@property(strong) NSNumber* myKey;
-@end
+@end \ No newline at end of file