summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLCompassDirection.h
blob: cad90cc908150383a0fa3479741f0f5551713e9b (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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
//  SDLCompassDirection.h
//


#import "SDLEnum.h"

/**
 * The list of potential compass directions.
 *
 * @since SDL 2.0
 */
@interface SDLCompassDirection : SDLEnum {
}

/**
 * @abstract Convert String to SDLCompassDirection
 * @param value The value of the string to get an object for
 * @return SDLCompassDirection
 */
+ (SDLCompassDirection *)valueOf:(NSString *)value;

/**
 * @abstract Store the enumeration of all possible SDLCompassDirection
 * @return An array that store all possible SDLCompassDirection
 */
+ (NSArray *)values;

/**
 * @abstract Direction North
 * @return A SDLCompassDirection with the value of *NORTH*
 */
+ (SDLCompassDirection *)NORTH;

/**
 * @abstract Direction Northwest
 * @return A SDLCompassDirection with the value of *NORTHWEST*
 */
+ (SDLCompassDirection *)NORTHWEST;

/**
 * @abstract Direction West
 * @return A SDLCompassDirection with the value of *WEST*
 */
+ (SDLCompassDirection *)WEST;

/**
 * @abstract Direction Southwest
 * @return A SDLCompassDirection with the value of *SOUTHWEST*
 */
+ (SDLCompassDirection *)SOUTHWEST;

/**
 * @abstract Direction South
 * @return A SDLCompassDirection with the value of *SOUTH*
 */
+ (SDLCompassDirection *)SOUTH;

/**
 * @abstract Direction Southeast
 * @return A SDLCompassDirection with the value of *SOUTHEAST*
 */
+ (SDLCompassDirection *)SOUTHEAST;

/**
 * @abstract Direction East
 * @return A SDLCompassDirection with the value of *EAST*
 */
+ (SDLCompassDirection *)EAST;

/**
 * @abstract Direction Northeast
 * @return A SDLCompassDirection with the value of *NORTHEAST*
 */
+ (SDLCompassDirection *)NORTHEAST;

@end