summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLGPSData.h
blob: cfeebaa412970d647fbdb3b34ca0bec1c52a5284 (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
//  SDLGPSData.h
//

#import "SDLRPCMessage.h"

@class SDLCompassDirection;
@class SDLDimension;


/**
 * Describes the GPS data. Not all data will be available on all carlines.
 * 
 * @since SDL 2.0
 */
@interface SDLGPSData : SDLRPCStruct {
}

/**
 * Constructs a newly allocated SDLGPSData object
 */
- (instancetype)init;

/**
 * Constructs a newly allocated SDLGPSData object indicated by the dictionary parameter
 * @param dict The dictionary to use
 */
- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;

/**
 * @abstract longitude degrees
 *
 * Required, Float, -180 - 180
 */
@property (strong) NSNumber *longitudeDegrees;

/**
 * @abstract latitude degrees
 *
 * Required, Float, -90 - 90
 */
@property (strong) NSNumber *latitudeDegrees;

/**
 * @abstract utc year
 *
 * Required, Integer, 2010 - 2100
 */
@property (strong) NSNumber *utcYear;

/**
 * @abstract utc month
 *
 * Required, Integer, 1 - 12
 */
@property (strong) NSNumber *utcMonth;

/**
 * @abstract utc day
 *
 * Required, Integer, 1 - 31
 */
@property (strong) NSNumber *utcDay;

/**
 * @abstract utc hours
 *
 * Required, Integer, 0 - 23
 */
@property (strong) NSNumber *utcHours;

/**
 * @abstract utc minutes
 *
 * Required, Integer, 0 - 59
 */
@property (strong) NSNumber *utcMinutes;

/**
 * @abstract utc seconds
 *
 * Required, Integer, 0 - 59
 */
@property (strong) NSNumber *utcSeconds;

/**
 * Potential Compass Directions
 */
@property (strong) SDLCompassDirection *compassDirection;

/**
 * @abstract The 3D positional dilution of precision.
 *
 * @discussion If undefined or unavailable, then value shall be set to 0
 *
 * Required, Float, 0.0 - 10.0
 */
@property (strong) NSNumber *pdop;

/**
 * @abstract The horizontal dilution of precision
 *
 * @discussion If undefined or unavailable, then value shall be set to 0
 *
 * Required, Float, 0.0 - 10.0
 */
@property (strong) NSNumber *hdop;

/**
 * @abstract the vertical dilution of precision
 *
 * @discussion If undefined or unavailable, then value shall be set to 0
 *
 * Required, Float, 0.0 - 10.0
 */
@property (strong) NSNumber *vdop;

/**
 * @abstract What the coordinates are based on
 *
 * @discussion YES, if coordinates are based on satellites. NO, if based on dead reckoning.
 *
 * Required, Boolean
 */
@property (strong) NSNumber *actual;

/**
 * @abstract The number of satellites in view
 *
 * Required, Integer, 0 - 31
 */
@property (strong) NSNumber *satellites;

/**
 * The supported dimensions of the GPS
 *
 * Required
 */
@property (strong) SDLDimension *dimension;

/**
 * @abstract altitude in meters
 *
 * Required, Float, -10000.0 - 10000.0
 */
@property (strong) NSNumber *altitude;

/**
 * @abstract Heading based on the GPS data.
 * 
 * @discussion North is 0, East is 90, etc. Resolution is 0.01
 *
 * Required, Float, 0.0 - 359.99
 */
@property (strong) NSNumber *heading;

/**
 * @abstract speed in KPH
 *
 * Required, Float, 0.0 - 500.0
 */
@property (strong) NSNumber *speed;

@end