author | Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> |
Tue, 24 Nov 2009 08:56:33 +0200 | |
changeset 23 | 50974a8b132e |
parent 19 | 8d692d9f828f |
child 34 | 5dae2c62e9b6 |
permissions | -rw-r--r-- |
5 | 1 |
/* |
2 |
* Copyright (c) 2006-2007 Nokia Corporation and/or its subsidiary(-ies). |
|
3 |
* All rights reserved. |
|
4 |
* This component and the accompanying materials are made available |
|
5 |
* under the terms of the License "Eclipse Public License v1.0" |
|
6 |
* which accompanies this distribution, and is available |
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 |
* |
|
9 |
* Initial Contributors: |
|
10 |
* Nokia Corporation - initial contribution. |
|
11 |
* |
|
12 |
* Contributors: |
|
13 |
* |
|
14 |
* Description: Header file for location SAPI service implementation. |
|
15 |
* |
|
16 |
*/ |
|
17 |
||
18 |
#ifndef LOCATIONSERVICE_H |
|
19 |
#define LOCATIONSERVICE_H |
|
20 |
||
21 |
#include <lbs.h> |
|
22 |
class CGetLoc; |
|
23 |
/** |
|
24 |
* Identity for location SAPI lib |
|
25 |
* This will be appended to requestor identity information stack received from the |
|
26 |
* client and will be passed onto location server |
|
27 |
*/ |
|
28 |
||
29 |
_LIT(KIdentity,"Location SAPI"); |
|
30 |
||
31 |
||
32 |
||
33 |
/** |
|
34 |
* Key for locating location information in CLiwGenericParamList |
|
35 |
*/ |
|
36 |
_LIT8(KLongitudeKey,"Longitude") ; |
|
37 |
_LIT8(KLatitudeKey , "Latitude") ; |
|
38 |
_LIT8(KAltitudeKey , "Altitude") ; |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
39 |
_LIT8(KHorAccuracy,"HorizontalAccuracy"); |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
40 |
_LIT8(KVerAccuracy,"VerticalAccuracy"); |
5 | 41 |
|
42 |
_LIT(KUnknown,"Unknown"); |
|
19 | 43 |
const TInt KMaxSupportedFields = 25 ; |
5 | 44 |
|
45 |
/** |
|
46 |
* Default Update options |
|
47 |
*/ |
|
48 |
//Second |
|
49 |
const TInt KSSecond = 1000000; |
|
50 |
||
51 |
//Update interval |
|
52 |
const TInt KSUpdateInterval = KSSecond; |
|
53 |
||
54 |
//Update time out |
|
55 |
const TInt KSUpdateTimeOut = 15*KSSecond; |
|
56 |
||
57 |
//MaxAge |
|
58 |
const TInt KSMaxAge = 0; |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
59 |
const TInt KGetLocationReq = 0 ; |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
60 |
const TInt KTraceReq = 1 ; |
19 | 61 |
const TInt errServiceNotReady = 1006; |
5 | 62 |
|
63 |
/** |
|
64 |
* Enums required for mathoperations |
|
65 |
*/ |
|
66 |
enum TMathOperationChoice |
|
67 |
{ |
|
68 |
EDistance = 0, |
|
69 |
EBearingTo = 1, |
|
70 |
EMove = 2 |
|
71 |
}; |
|
72 |
||
73 |
/** |
|
74 |
* Notification Type to be cancelled |
|
75 |
*/ |
|
76 |
enum TCancelParam |
|
77 |
{ |
|
78 |
ECancelGetLocation = 0, |
|
79 |
ECancelTrace = 1 |
|
80 |
}; |
|
81 |
/** |
|
82 |
* Enumeration used to identify category of location information user intends to |
|
83 |
* retrieve |
|
84 |
* Example: specifying EBasic user will get only longitude,latitude and altitude |
|
85 |
*/ |
|
86 |
enum TLocationInfoType |
|
87 |
{ |
|
88 |
EBasicInfo = 0, |
|
89 |
EGenericInfo = 1 |
|
90 |
}; |
|
91 |
||
92 |
/** |
|
93 |
* used by the caller of math operation to send input parameters |
|
94 |
* after computation MathOperation wil fill in result field of this |
|
95 |
* struct. |
|
96 |
*/ |
|
97 |
struct _INPPARM |
|
98 |
{ |
|
99 |
//specifies option for mathoperation |
|
100 |
TInt servicechoice; |
|
101 |
//result of the computation |
|
102 |
TReal32 result ; |
|
103 |
//Source Coordinate for math operation |
|
104 |
TCoordinate source; |
|
105 |
//Destination Coordinate for math operation |
|
106 |
TCoordinate destination ; |
|
107 |
//In case of find bearingto following two should be supplied by the consumer |
|
108 |
TReal32 bearing; |
|
109 |
TReal32 distance; |
|
110 |
||
111 |
}; |
|
112 |
||
113 |
typedef struct _INPPARM inpparam; |
|
114 |
||
115 |
||
116 |
||
117 |
/** |
|
118 |
* Location callback interface, its pure interface class, application need to |
|
119 |
* Write there own callback derriving from this class. |
|
120 |
* @Depenedency lbs.lib |
|
121 |
*/ |
|
122 |
||
123 |
class MLocationCallBack |
|
124 |
{ |
|
125 |
/** |
|
126 |
* Handles notifications caused by an asynchronous GetLocationL, |
|
127 |
* or by trace. |
|
128 |
* |
|
129 |
* @param aOutPos updated position got from location server |
|
130 |
* @return Success/Error code for the callback. |
|
131 |
* |
|
132 |
* @see HPositionGenericInfo in LbsPositionInfo.h for details |
|
133 |
* |
|
134 |
*/ |
|
135 |
public : |
|
136 |
virtual TInt HandleNotifyL(HPositionGenericInfo* aOutPos , TInt aError) = 0 ; |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
137 |
/* |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
138 |
* To be implemented by every class that derives from this. This function should return |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
139 |
* the Async Request type for which this callback is used. |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
140 |
*/ |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
141 |
|
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
142 |
virtual TUint GetRequestType(void) = 0; |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
143 |
|
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
144 |
/* |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
145 |
* To be implemented by every class that derives from this. This returns the |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
146 |
* TransactionId associated with the Async request for which this Callback |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
147 |
* object is used. |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
148 |
*/ |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
149 |
|
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
150 |
virtual TInt32 GetTransactionId(void) = 0; |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
151 |
|
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
152 |
|
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
153 |
virtual ~MLocationCallBack(){} |
5 | 154 |
}; |
155 |
||
156 |
||
157 |
/** |
|
158 |
* CLocationService class : This is a wrapper class for the Functionalities |
|
159 |
* offered by Location Retreival APIs. |
|
160 |
* In case of An Asynchronus request it has method which Instantiates and delegate |
|
161 |
* the job to another class which also opens new sub-session with |
|
162 |
* Location server. |
|
163 |
*/ |
|
164 |
||
165 |
||
166 |
class CLocationService : public CBase |
|
167 |
{ |
|
168 |
public : |
|
169 |
/** |
|
170 |
* Creates a new instance of a @ref CLocationService |
|
171 |
* @return The newly created CLocationService object |
|
172 |
*/ |
|
173 |
IMPORT_C static CLocationService *NewL() ; |
|
174 |
||
175 |
||
176 |
/* |
|
177 |
* @Destructor |
|
178 |
*/ |
|
179 |
virtual ~CLocationService() ; |
|
180 |
||
181 |
/** |
|
182 |
* Methods on the Core Location implementation |
|
183 |
*/ |
|
184 |
||
185 |
||
186 |
||
187 |
/** |
|
188 |
* Synchronous get location with update options returns current location of the user |
|
189 |
* |
|
190 |
* @param aPosinfobase input TPositionInfoBase object which will hold location details |
|
191 |
* @param aUpdateOpts updateoptions for synchronous calls |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
192 |
* @param aEnableHighAcc - Tells whether to use greater accuracy modules to obtain updates |
5 | 193 |
*/ |
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
194 |
IMPORT_C void GetLocationL( TPositionInfoBase* aPos , |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
195 |
const TPositionUpdateOptions* aUpdateOpts= NULL, |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
196 |
TBool aEnableHighAcc = false ) ; |
5 | 197 |
|
198 |
||
199 |
/** |
|
200 |
* Gets the current location of user asynchronosly calls the users callback handle on reciving |
|
201 |
* location updates |
|
202 |
* @param aCallBack callback object after reciving the position updates |
|
203 |
* @param aLocationInfoCategory specifying one of the enumeration in TLocationInfoType. |
|
204 |
* @param aFieldIdList specifies field of HPositionGenericInfo that user intend to retrieve. |
|
205 |
* @param aUpdateoptions update options for asynchronous requests. |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
206 |
* @param aEnableHighAcc - Tells whether to use greater accuracy modules to obtain updates |
5 | 207 |
* @see Lsbcommon.h for details of TPositionFieldIdList and TPositionUpdateOptions |
208 |
*/ |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
209 |
IMPORT_C void GetLocationL( MLocationCallBack* aCallBackObj , |
5 | 210 |
TInt aLocationInfoCategory = 0, |
211 |
TPositionFieldIdList aFieldIdList = NULL , |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
212 |
const TPositionUpdateOptions* aUpdateopts = NULL, |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
213 |
TBool aEnableHighAcc = false |
5 | 214 |
); |
215 |
||
216 |
/** |
|
217 |
* Gets module information of the Positioning module specified my aModuleId |
|
218 |
* |
|
219 |
* @param TPositionModuleId param to store the obtained module information |
|
220 |
* |
|
221 |
* @see lsbcommon.h for details of TPositionModuleInfoBase |
|
222 |
*/ |
|
223 |
IMPORT_C TInt GetModuleInfo( TPositionModuleInfoBase& aModuleInfo ) const ; |
|
224 |
||
225 |
/** |
|
226 |
* Performs mathoperations (move,distance,bearingto) by parsing contents of input param |
|
227 |
* |
|
228 |
* @param aInput input paramater for math opertaions |
|
229 |
* |
|
230 |
* @see inparam in this file for detailed math operation list |
|
231 |
*/ |
|
232 |
||
233 |
||
234 |
IMPORT_C TInt MathOperation( inpparam& aInput ); |
|
235 |
||
236 |
/** |
|
237 |
* Trace function traces users location changes any change in users current location is notificed |
|
238 |
* to user via call back function |
|
239 |
* |
|
240 |
* @param aCallBackObj callback object after reciving location updates |
|
241 |
* @param aLocationInfoCategory specifying one of the enumeration in TLocationInfoType. |
|
242 |
* @param aFiledList List of position fields that should be retrived |
|
243 |
* @param aUpdateOptions update options for trace |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
244 |
* @param aEnableHighAcc Tells whether to use greater accuracy modules to obtain updates |
5 | 245 |
* @see Lsbcommon.h for details of TPositionFieldIdList and TPositionUpdateOptions |
246 |
*/ |
|
247 |
||
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
248 |
IMPORT_C void TraceL(MLocationCallBack* aCallBackObj , |
5 | 249 |
TInt aLocationInfoCategory = 0, |
250 |
TPositionFieldIdList aFiledList = NULL , |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
251 |
const TPositionUpdateOptions* aUpateOptions= NULL, |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
252 |
TBool aEnableHighAcc = false); |
5 | 253 |
|
254 |
||
255 |
/** |
|
256 |
* Method to cancell pending async request |
|
257 |
* |
|
258 |
* aCancelparam cancellation type (trace,getlocation) |
|
259 |
* |
|
260 |
* @see TCancelParam for cancellation options |
|
261 |
*/ |
|
262 |
||
263 |
IMPORT_C TInt CancelOnGoingService( TInt aCancelparam ) ; |
|
264 |
||
265 |
/** |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
266 |
* Method to cancel pending async request |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
267 |
* |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
268 |
* aTransId Transaction Id that was returned for an Async request |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
269 |
*/ |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
270 |
IMPORT_C TInt CancelService( TInt aTransId); |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
271 |
|
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
272 |
/** |
5 | 273 |
* Method to fetch last known location from location server |
274 |
*/ |
|
275 |
||
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
276 |
IMPORT_C TInt GetLastKnownLoc( TPosition& aResultPos ) ; |
5 | 277 |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
278 |
/** |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
279 |
* Method to obtain the High Accuracy module out of the |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
280 |
* currently available modules on the phone |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
281 |
*/ |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
282 |
|
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
283 |
void GetHighAccuracyModuleL(TPositionModuleId* aModId); |
19 | 284 |
TInt SetSupportedFields() ; |
285 |
TInt SetRequestingField(); |
|
5 | 286 |
|
287 |
||
288 |
||
289 |
protected: |
|
290 |
/** |
|
291 |
* internal method to construct class members |
|
292 |
*/ |
|
293 |
void ConstructL() ; |
|
294 |
||
295 |
/** |
|
296 |
* Default constructor |
|
297 |
*/ |
|
298 |
CLocationService() ; |
|
299 |
||
300 |
||
301 |
private : |
|
302 |
||
303 |
/** |
|
304 |
* Subsession used to fetch location information |
|
305 |
*/ |
|
306 |
||
307 |
RPositioner iPositioner; |
|
308 |
||
309 |
/** |
|
310 |
* Session used for getting location information |
|
311 |
*/ |
|
312 |
||
313 |
RPositionServer iPosServer; |
|
314 |
||
315 |
/** |
|
316 |
* Registration table for callbacks |
|
317 |
*/ |
|
318 |
||
319 |
RPointerArray<CGetLoc> iRegTable; |
|
320 |
||
321 |
||
322 |
/** |
|
323 |
* Module indtifier used by location server for getting location information |
|
324 |
*/ |
|
325 |
TPositionModuleId iModuleId ; |
|
19 | 326 |
/** |
327 |
* Member variable which holds all the Generic position information |
|
328 |
*/ |
|
329 |
||
330 |
HPositionGenericInfo *iGenericPosInfo ; |
|
331 |
/** |
|
332 |
* Class member which contains all the field ids of all the supported Hposition info fields |
|
333 |
*/ |
|
334 |
||
335 |
TPositionFieldId iFieldList[KMaxSupportedFields] ; |
|
336 |
/** |
|
337 |
* Class member which contains module information which is used for location esitmation |
|
338 |
*/ |
|
339 |
TPositionModuleInfo iModuleInfo ; |
|
5 | 340 |
|
341 |
}; |
|
342 |
||
343 |
||
344 |
#endif // LOCATIONSERVICE_H |