summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLVehicleDataResultCode.h
diff options
context:
space:
mode:
authorJoel Fischer <joeljfischer@gmail.com>2016-05-25 08:44:23 -0400
committerJoel Fischer <joeljfischer@gmail.com>2016-05-25 08:44:23 -0400
commitfb8e9903a323acaf5fc78819bb3c203567542ab2 (patch)
treee40665103ac7db492e0a40e34cd92f3390defa55 /SmartDeviceLink/SDLVehicleDataResultCode.h
parentf7540a02262832e34c67b0953dd8a1804a046fea (diff)
downloadsdl_ios-fb8e9903a323acaf5fc78819bb3c203567542ab2.tar.gz
Shift files into root directory
Diffstat (limited to 'SmartDeviceLink/SDLVehicleDataResultCode.h')
-rw-r--r--SmartDeviceLink/SDLVehicleDataResultCode.h71
1 files changed, 71 insertions, 0 deletions
diff --git a/SmartDeviceLink/SDLVehicleDataResultCode.h b/SmartDeviceLink/SDLVehicleDataResultCode.h
new file mode 100644
index 000000000..162ecff59
--- /dev/null
+++ b/SmartDeviceLink/SDLVehicleDataResultCode.h
@@ -0,0 +1,71 @@
+// SDLVehicleDataResultCode.h
+//
+
+
+#import "SDLEnum.h"
+
+/**
+ Vehicle Data Result Code
+ */
+@interface SDLVehicleDataResultCode : SDLEnum {
+}
+
+/**
+ * Convert String to SDLVehicleDataResultCode
+ * @param value String
+ * @return SDLVehicleDataResultCode
+ */
++ (SDLVehicleDataResultCode *)valueOf:(NSString *)value;
+
+/**
+ @abstract Store the enumeration of all possible SDLVehicleDataResultCode
+ @return an array that store all possible SDLVehicleDataResultCode
+ */
++ (NSArray *)values;
+
+/**
+ * Individual vehicle data item / DTC / DID request or subscription successful
+ */
++ (SDLVehicleDataResultCode *)SUCCESS;
+
+/**
+ * DTC / DID request successful, however, not all active DTCs or full contents of DID location available
+ */
++ (SDLVehicleDataResultCode *)TRUNCATED_DATA;
+
+/**
+ * This vehicle data item is not allowed for this app by SDL
+ */
++ (SDLVehicleDataResultCode *)DISALLOWED;
+
+/**
+ * The user has not granted access to this type of vehicle data item at this time
+ */
++ (SDLVehicleDataResultCode *)USER_DISALLOWED;
+
+/**
+ * The ECU ID referenced is not a valid ID on the bus / system
+ */
++ (SDLVehicleDataResultCode *)INVALID_ID;
+
+/**
+ * The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system
+ */
++ (SDLVehicleDataResultCode *)VEHICLE_DATA_NOT_AVAILABLE;
+
+/**
+ * The vehicle data item is already subscribed
+ */
++ (SDLVehicleDataResultCode *)DATA_ALREADY_SUBSCRIBED;
+
+/**
+ * The vehicle data item cannot be unsubscribed because it is not currently subscribed
+ */
++ (SDLVehicleDataResultCode *)DATA_NOT_SUBSCRIBED;
+
+/**
+ * The request for this item is ignored because it is already in progress
+ */
++ (SDLVehicleDataResultCode *)IGNORED;
+
+@end