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 core implementation. |
|
15 |
* |
|
16 |
*/ |
|
17 |
||
18 |
#ifndef C_LOCINTERFACE_H |
|
19 |
#define C_LOCINTERFACE_H |
|
20 |
||
21 |
||
23
50974a8b132e
Revision: 200945
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
19
diff
changeset
|
22 |
#include <liwcommon.h> |
5 | 23 |
#include "locationcb.h" |
24 |
#include "locationservice.h" |
|
25 |
#include "serviceerrno.h" |
|
26 |
||
27 |
||
28 |
// CONSTANTS |
|
29 |
||
30 |
||
31 |
||
32 |
//Second |
|
33 |
const TInt KLocSecond = 1000000; |
|
34 |
||
35 |
//Update interval |
|
36 |
const TInt KLocUpdateInterval = KLocSecond; |
|
37 |
||
38 |
//Update time out |
|
39 |
const TInt KLocUpdateTimeOut = 15*KLocSecond; |
|
40 |
||
41 |
//MaxAge |
|
42 |
const TInt KLocMaxAge = 0; |
|
43 |
||
44 |
||
45 |
/** |
|
46 |
* Various command for Location service |
|
47 |
*/ |
|
48 |
||
49 |
_LIT8( KCmdGetLocation , "GetLocation" ) ; |
|
50 |
_LIT8( KCmdTraceLocation, "Trace" ) ; |
|
51 |
_LIT8( KCmdCancelRequest, "CancelNotification" ) ; |
|
52 |
||
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
53 |
_LIT8(KCmdLastLocation,"GetLastPosition"); |
5 | 54 |
_LIT( KRequestTrace ,"TraceCancel") ; |
55 |
_LIT( KRequestGetLoc , "GetLocCancel" ) ; |
|
56 |
_LIT8( KRequestCalculate , "Calculate") ; |
|
57 |
||
58 |
_LIT8( KMathRequest , "MathRequest") ; |
|
59 |
_LIT8( KCancelType , "CancelRequestType") ; |
|
60 |
||
61 |
/** |
|
62 |
* Error Indntifier in Output parameter list |
|
63 |
*/ |
|
64 |
_LIT8(KErrorCode , "ErrorCode") ; |
|
65 |
||
66 |
/** |
|
67 |
* Error string |
|
68 |
*/ |
|
69 |
_LIT8(KErrorMessage,"ErrorMessage"); |
|
70 |
||
71 |
/** |
|
72 |
* Location SAPI result parmater identifiers |
|
73 |
*/ |
|
74 |
_LIT8(KLocationMap , "ReturnValue") ; |
|
75 |
||
76 |
/** |
|
77 |
* Update Options |
|
78 |
*/ |
|
79 |
_LIT8(KUpdateOptionMap,"Updateoptions"); |
|
80 |
_LIT8(KUpdateOptionInterval,"UpdateInterval"); |
|
81 |
_LIT8(KUpdateOptionTimeOut,"UpdateTimeOut"); |
|
82 |
_LIT8(KUpdateOptionMaxAge,"UpdateMaxAge"); |
|
83 |
_LIT8(KPartialUpdates , "PartialUpdates"); |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
84 |
/** |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
85 |
* EnableHighAccuracy parameter |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
86 |
*/ |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
87 |
_LIT8(KEnableHighAccuracy,"EnableHighAccuracy"); |
5 | 88 |
|
89 |
/** |
|
90 |
* Class of Location Information ;user is |
|
91 |
* looking for |
|
92 |
*/ |
|
93 |
_LIT8(KLocationInfoCategory,"LocationInformationClass"); |
|
94 |
_LIT(KLocationBasicinfo,"BasicLocationInformation"); |
|
95 |
_LIT(KLocationGenericInfo,"GenericLocationInfo"); |
|
96 |
||
97 |
/** |
|
98 |
* Math operations request identifiers |
|
99 |
*/ |
|
100 |
_LIT( KRequestDistance , "FindDistance") ; |
|
101 |
_LIT(KRequestBearingTo,"FindBearingTo"); |
|
102 |
_LIT(KRequestMove,"MoveCoordinates"); |
|
103 |
_LIT8(KDistanceParmSource , "DistanceParamSource") ; |
|
104 |
_LIT8(KDistanceMove , "MoveByThisDistance"); |
|
105 |
_LIT8(KBearingMove , "MoveByThisBearing"); |
|
106 |
_LIT8(KDistanceParmDestination , "DistanceParamDestination") ; |
|
107 |
_LIT8(KMathOpResult,"ReturnValue"); |
|
108 |
||
109 |
||
110 |
/** |
|
111 |
* Speed informations which will be part of outparamlist |
|
112 |
*/ |
|
113 |
||
114 |
_LIT8(KPositionFieldHorizontalSpeed , "HorizontalSpeed") ; |
|
115 |
_LIT8(KPositionFieldVerticalSpeed , "VeritcalSpeed") ; |
|
116 |
_LIT8(KPositionFieldHorizontalSpeedError , "HorizontalSpeedError") ; |
|
117 |
_LIT8(KPositionFieldVerticalSpeedError , "VeritcalSpeedError") ; |
|
118 |
||
119 |
/** |
|
120 |
* Satellite information which be part of outparm list |
|
121 |
*/ |
|
122 |
_LIT8(KPositionFieldSatelliteNumInView , "SatelliteNumView") ; |
|
123 |
_LIT8(KPositionFieldSatelliteNumUsed , "SatelliteNumViewUsed") ; |
|
124 |
_LIT8(KPositionFieldSatelliteTime , "SatelliteTime") ; |
|
125 |
||
126 |
/** |
|
127 |
* Compass information which will be part of outparmlist |
|
128 |
*/ |
|
129 |
_LIT8(KPositionFieldHeading , "Heading") ; |
|
130 |
_LIT8(KPositionFieldHeadingError , "HeadingError") ; |
|
131 |
_LIT8(KPositionFieldMagneticHeading , "MagneticHeading") ; |
|
132 |
_LIT8(KPositionFieldMagneticHeadingError , "MagneticHeadingError") ; |
|
133 |
||
134 |
/** |
|
135 |
* Direction course information which will be part of outparm list |
|
136 |
*/ |
|
137 |
_LIT8(KPositionFieldTrueCourse , "TrueCourse") ; |
|
138 |
_LIT8(KPositionFieldTrueCourseError , "TrueCourseError") ; |
|
139 |
_LIT8(KPositionFieldMagneticCourse , "MagneticCourse") ; |
|
140 |
_LIT8(KPositionFieldMagneticCourseError , "MagneticCourseError") ; |
|
141 |
||
142 |
||
143 |
/** |
|
144 |
* Enum specifier for postion Info Category |
|
145 |
* |
|
146 |
*/ |
|
147 |
enum TPositionCategory |
|
148 |
{ |
|
149 |
EBasicPositionInfo = 0, |
|
150 |
EGenericPositionInfo = 1 |
|
151 |
}; |
|
152 |
||
153 |
/** |
|
154 |
* Transaction id, which will be part of outparamlist for asynchronous request |
|
155 |
*/ |
|
156 |
_LIT8(KTransactionId, "TransactionID"); |
|
157 |
||
158 |
/** |
|
159 |
* This is an interface class for Location SAPI This class implements ExecuteCmdL() method |
|
160 |
* ExecuteCmdL() method is called directly by consumer after descovering the service |
|
161 |
*/ |
|
162 |
||
163 |
class CLocationInterface : public CBase ,public MLiwInterface |
|
164 |
{ |
|
165 |
public: |
|
166 |
enum TIndex |
|
167 |
{ |
|
168 |
Index0 = 0, |
|
169 |
Index1, |
|
170 |
Index2, |
|
171 |
Index3 |
|
172 |
}; |
|
173 |
/** |
|
174 |
* A static method for creating CLocationInterface object |
|
175 |
*/ |
|
176 |
static CLocationInterface *NewL() ; |
|
177 |
||
178 |
||
179 |
/** |
|
180 |
* Default destructor |
|
181 |
*/ |
|
182 |
virtual ~CLocationInterface() ; |
|
183 |
||
184 |
/** |
|
185 |
* ExecuteCmdL parses the input parameters and then calls an appropriate method on iLocationServic |
|
186 |
* |
|
187 |
* @param aCmdName the name of the service command which the consumer wants to invoke |
|
188 |
* @param aInParamList the input parameter list, can be empty list |
|
189 |
* @param [in,out] aOutParamList the output parameter list, can be empty lis. The |
|
190 |
* service provider can use the output parameter list to fill in necessary return values |
|
191 |
* @param aCmdOptions Options for the command, see TLiwServiceCmdOptions in LiwCommon.hrh. |
|
192 |
* @param aCallback callback to be registered by consumer application |
|
193 |
* |
|
194 |
* @see TLiwServiceCmdOptions |
|
195 |
* @see CLiwGenericParamList |
|
196 |
* @see MLiwNotifyCallback |
|
197 |
*/ |
|
198 |
virtual void ExecuteCmdL( const TDesC8& aCmdName, |
|
199 |
const CLiwGenericParamList& aInParamList, |
|
200 |
CLiwGenericParamList& aOutParamList, |
|
201 |
TUint aCmdOptions = 0, |
|
202 |
MLiwNotifyCallback* aCallback = 0 ); |
|
203 |
static TInt ConvertToSapiError(TInt aSymbianErrorCode); |
|
204 |
||
205 |
/** |
|
206 |
* Close function called by consumer when it wants to delete the interface |
|
207 |
*/ |
|
208 |
virtual void Close() {delete this;} |
|
209 |
||
210 |
private : |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
211 |
|
5 | 212 |
|
213 |
/** |
|
214 |
* Internal private function which extracts coordinate information from CLiwMap |
|
215 |
* passed by consumer, this is required for math operations |
|
216 |
* |
|
217 |
* @param aCoordinate which will contain extracted coordinate info from map |
|
218 |
* @param input map containing cooridinate information |
|
219 |
*/ |
|
220 |
void FillCoordinatesL( TCoordinate &aCoordinate , const CLiwMap *aMap ) ; |
|
221 |
||
222 |
/** |
|
223 |
* SetUpdateOption construct a TPositionUpdateOptions object from the map containing |
|
224 |
* different field of update optiin. |
|
225 |
* |
|
226 |
* @param aPositionUpdateoption object to be constructed |
|
227 |
* @param aUpdatemap map containing values of different field of update option. |
|
228 |
* return -1 if negative value for timeinterval is given |
|
229 |
*/ |
|
230 |
TInt SetUpdateOption(TPositionUpdateOptions& aPositionUpdateoption,const CLiwMap* aUpdatemap); |
|
231 |
||
232 |
private : |
|
233 |
/** |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
234 |
* By default Symbian 2nd phase constructor is private. |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
235 |
* |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
236 |
*/ |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
237 |
void ConstructL(); |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
238 |
/** |
5 | 239 |
*Default constructor |
240 |
*/ |
|
241 |
||
242 |
CLocationInterface() ; |
|
243 |
||
244 |
/** |
|
245 |
* Internal CmdExecute function which parses the input parameters |
|
246 |
* this function is called by ExecuteCmdL() function |
|
247 |
* |
|
248 |
* @param aCmdName the name of the service command which the consumer wants to invoke |
|
249 |
* @param aInParamList the input parameter list, can be empty list |
|
250 |
* @param [in,out] aOutParamList the output parameter list, can be empty lis. The |
|
251 |
* service provider can use the output parameter list to fill in necessary return values |
|
252 |
* @param aCmdOptions Options for the command, see TLiwServiceCmdOptions in LiwCommon.hrh. |
|
253 |
* @param aCallback callback to be registered by consumer application |
|
254 |
* @see TLiwServiceCmdOptions |
|
255 |
* @see CLiwGenericParamList |
|
256 |
* @see MLiwNotifyCallback |
|
257 |
* |
|
258 |
*/ |
|
259 |
||
260 |
||
261 |
void CmdExecuteL( |
|
262 |
const TDesC8& aCmdName, |
|
263 |
const CLiwGenericParamList& aInParamList , |
|
264 |
CLiwGenericParamList& aOutParamList, |
|
265 |
TUint aCmdOptions, |
|
266 |
MLiwNotifyCallback* aCallback); |
|
267 |
||
268 |
/** |
|
269 |
* Internal utility function which fills iGenericPosinfo accoriding to capability of |
|
270 |
* Positioning module used for location estimation |
|
271 |
*/ |
|
272 |
||
273 |
||
274 |
/** |
|
275 |
* Internal utility function which gets all location information which module supports |
|
276 |
* |
|
277 |
* @param aOutParamList output list which is populated with location informatio |
|
278 |
* @param aPosInfoCategory position category (Basic or Generic) |
|
279 |
*/ |
|
280 |
||
281 |
void GetLocationInfo( CLiwGenericParamList& aOutParamList,TInt aPosInfoCategory) ; |
|
282 |
||
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
283 |
|
5 | 284 |
|
285 |
/** |
|
286 |
* Handle to core location class for performing location operations |
|
287 |
*/ |
|
288 |
CLocationService *iLocationService ; |
|
289 |
||
290 |
/** |
|
291 |
* Registration table for callbacks |
|
292 |
*/ |
|
293 |
RPointerArray<LocationInterfaceCB> iHandleCB; |
|
294 |
||
295 |
||
296 |
/** |
|
10
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
297 |
* Class member which is used to obtain updates of Last Known Position |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
298 |
*/ |
fc9cf246af83
Revision: 200931
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
5
diff
changeset
|
299 |
TPosition iPosition; |
5 | 300 |
/** |
19 | 301 |
* Generic position class |
302 |
*/ |
|
303 |
HPositionGenericInfo *iGenericPosition; |
|
5 | 304 |
|
305 |
}; |
|
306 |
||
307 |
||
308 |
#endif //C_LOCINTERFACE_H |