summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLFuelCutoffStatus.h
blob: df213ff07f41c7566e065cc40e1e3d8f81be856b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
//  SDLFuelCutoffStatus.h
//


#import "SDLEnum.h"

/** 
 * Reflects the status of the Restraints Control Module fuel pump cutoff.
 * The fuel pump is cut off typically after the vehicle has had a collision.
 *
 * @since SDL 2.0
 */
@interface SDLFuelCutoffStatus : SDLEnum {
}

/**
 * @abstract Convert String to SDLFuelCutoffStatus
 *
 * @param value String value to retrieve the object for
 *
 * @return SDLFuelCutoffStatus
 */
+ (SDLFuelCutoffStatus *)valueOf:(NSString *)value;

/**
 * @abstract Store the enumeration of all possible SDLFuelCutoffStatus
 *
 * @return an array that stores all possible SDLFuelCutoffStatus
 */
+ (NSArray *)values;

/** 
 * @abstract Fuel is cut off
 * @return the fuel cutoff status: *TERMINATE_FUEL*
 */
+ (SDLFuelCutoffStatus *)TERMINATE_FUEL;

/** 
 * @abstract Fuel is not cut off
 * @return the fuel cutoff status: *NORMAL_OPERATION*
 */
+ (SDLFuelCutoffStatus *)NORMAL_OPERATION;

/** 
 * @abstract Status of the fuel pump cannot be determined
 * @return the fuel cutoff status: *FAULT*
 */
+ (SDLFuelCutoffStatus *)FAULT;

@end