equal
deleted
inserted
replaced
1 /* |
1 /* |
2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies). |
2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies). |
3 * All rights reserved. |
3 * All rights reserved. |
4 * This component and the accompanying materials are made available |
4 * This component and the accompanying materials are made available |
5 * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
5 * under the terms of "Eclipse Public License v1.0" |
6 * which accompanies this distribution, and is available |
6 * which accompanies this distribution, and is available |
7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
8 * |
8 * |
9 * Initial Contributors: |
9 * Initial Contributors: |
10 * Nokia Corporation - initial contribution. |
10 * Nokia Corporation - initial contribution. |
11 * |
11 * |
12 * Contributors: |
12 * Contributors: |
54 * This is an internal class to provide the interface for the |
54 * This is an internal class to provide the interface for the |
55 * HPositionGenericInfo::GetValue() and HPositionGenericInfo::SetValue() |
55 * HPositionGenericInfo::GetValue() and HPositionGenericInfo::SetValue() |
56 * methods. Methods in this class are not intended to be called directly. |
56 * methods. Methods in this class are not intended to be called directly. |
57 * Clients should use HPositionGenericInfo::GetValue() and |
57 * Clients should use HPositionGenericInfo::GetValue() and |
58 * HPositionGenericInfo::SetValue() methods. |
58 * HPositionGenericInfo::SetValue() methods. |
59 * @internalTechnology |
59 * @publishedAll |
60 * @released |
60 * @released |
61 */ |
61 */ |
62 class PositionFieldManager |
62 class PositionFieldManager |
63 { |
63 { |
64 public: |
64 public: |
120 /** |
120 /** |
121 * Get the value for a location field of data type TInt8 from the |
121 * Get the value for a location field of data type TInt8 from the |
122 * HPositionGenericInfo. |
122 * HPositionGenericInfo. |
123 * @param aFieldId Id of the field for which the value should be read from |
123 * @param aFieldId Id of the field for which the value should be read from |
124 * HPositionGenericInfo. |
124 * HPositionGenericInfo. |
125 * @param[out] aValue The object where the data from the |
125 * @param [out] aValue The object where the data from the |
126 * HPositionGenericInfo is returned. |
126 * HPositionGenericInfo is returned. |
127 * @param[in] aInfo The HPositionGenericInfo object from where this field needs |
127 * @param [in] aInfo The HPositionGenericInfo object from where this field needs |
128 * to be read. |
128 * to be read. |
129 * @return KErrNone is the operation was successful. |
129 * @return KErrNone is the operation was successful. |
130 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
130 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
131 */ |
131 */ |
132 IMPORT_C static TInt GetValue(TPositionFieldId aFieldId, |
132 IMPORT_C static TInt GetValue(TPositionFieldId aFieldId, |
154 /** |
154 /** |
155 * Get the value for a location field of data type TInt16 from the |
155 * Get the value for a location field of data type TInt16 from the |
156 * HPositionGenericInfo. |
156 * HPositionGenericInfo. |
157 * @param aFieldId Id of the field for which the value should be read from |
157 * @param aFieldId Id of the field for which the value should be read from |
158 * HPositionGenericInfo. |
158 * HPositionGenericInfo. |
159 * @param[in] aValue The object where the data from the |
159 * @param [in] aValue The object where the data from the |
160 * HPositionGenericInfo is returned. |
160 * HPositionGenericInfo is returned. |
161 * @param aInfo The HPositionGenericInfo object from where this field needs |
161 * @param aInfo The HPositionGenericInfo object from where this field needs |
162 * to be read. |
162 * to be read. |
163 * @return KErrNone is the operation was successful. |
163 * @return KErrNone is the operation was successful. |
164 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
164 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
188 /** |
188 /** |
189 * Get the value for a location field of data type TInt32 from the |
189 * Get the value for a location field of data type TInt32 from the |
190 * HPositionGenericInfo. |
190 * HPositionGenericInfo. |
191 * @param aFieldId Id of the field for which the value should be read from |
191 * @param aFieldId Id of the field for which the value should be read from |
192 * HPositionGenericInfo. |
192 * HPositionGenericInfo. |
193 * @param[out] aValue The object where the data from the |
193 * @param [out] aValue The object where the data from the |
194 * HPositionGenericInfo is returned. |
194 * HPositionGenericInfo is returned. |
195 * @param aInfo The HPositionGenericInfo object from where this field needs |
195 * @param aInfo The HPositionGenericInfo object from where this field needs |
196 * to be read. |
196 * to be read. |
197 * @return KErrNone is the operation was successful. |
197 * @return KErrNone is the operation was successful. |
198 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
198 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
222 /** |
222 /** |
223 * Get the value for a location field of data type TInt64 from the |
223 * Get the value for a location field of data type TInt64 from the |
224 * HPositionGenericInfo. |
224 * HPositionGenericInfo. |
225 * @param aFieldId Id of the field for which the value should be read from |
225 * @param aFieldId Id of the field for which the value should be read from |
226 * HPositionGenericInfo. |
226 * HPositionGenericInfo. |
227 * @param[out] aValue The object where the data from the |
227 * @param [out] aValue The object where the data from the |
228 * HPositionGenericInfo is returned. |
228 * HPositionGenericInfo is returned. |
229 * @param aInfo The HPositionGenericInfo object from where this field needs |
229 * @param aInfo The HPositionGenericInfo object from where this field needs |
230 * to be read. |
230 * to be read. |
231 * @return KErrNone is the operation was successful. |
231 * @return KErrNone is the operation was successful. |
232 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
232 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
256 /** |
256 /** |
257 * Get the value for a location field of data type TUint8 from the |
257 * Get the value for a location field of data type TUint8 from the |
258 * HPositionGenericInfo. |
258 * HPositionGenericInfo. |
259 * @param aFieldId Id of the field for which the value should be read from |
259 * @param aFieldId Id of the field for which the value should be read from |
260 * HPositionGenericInfo. |
260 * HPositionGenericInfo. |
261 * @param[out] aValue The object where the data from the |
261 * @param [out] aValue The object where the data from the |
262 * HPositionGenericInfo is returned. |
262 * HPositionGenericInfo is returned. |
263 * @param aInfo The HPositionGenericInfo object from where this field needs |
263 * @param aInfo The HPositionGenericInfo object from where this field needs |
264 * to be read. |
264 * to be read. |
265 * @return KErrNone is the operation was successful. |
265 * @return KErrNone is the operation was successful. |
266 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
266 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
290 /** |
290 /** |
291 * Get the value for a location field of data type TUint16 from the |
291 * Get the value for a location field of data type TUint16 from the |
292 * HPositionGenericInfo. |
292 * HPositionGenericInfo. |
293 * @param aFieldId Id of the field for which the value should be read from |
293 * @param aFieldId Id of the field for which the value should be read from |
294 * HPositionGenericInfo. |
294 * HPositionGenericInfo. |
295 * @param[out] aValue The object where the data from the |
295 * @param [out] aValue The object where the data from the |
296 * HPositionGenericInfo is returned. |
296 * HPositionGenericInfo is returned. |
297 * @param aInfo The HPositionGenericInfo object from where this field needs |
297 * @param aInfo The HPositionGenericInfo object from where this field needs |
298 * to be read. |
298 * to be read. |
299 * @return KErrNone is the operation was successful. |
299 * @return KErrNone is the operation was successful. |
300 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
300 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
324 /** |
324 /** |
325 * Get the value for a location field of data type TUint32 from the |
325 * Get the value for a location field of data type TUint32 from the |
326 * HPositionGenericInfo. |
326 * HPositionGenericInfo. |
327 * @param aFieldId Id of the field for which the value should be read from |
327 * @param aFieldId Id of the field for which the value should be read from |
328 * HPositionGenericInfo. |
328 * HPositionGenericInfo. |
329 * @param[out] aValue The object where the data from the |
329 * @param [out] aValue The object where the data from the |
330 * HPositionGenericInfo is returned. |
330 * HPositionGenericInfo is returned. |
331 * @param aInfo The HPositionGenericInfo object from where this field needs |
331 * @param aInfo The HPositionGenericInfo object from where this field needs |
332 * to be read. |
332 * to be read. |
333 * @return KErrNone is the operation was successful. |
333 * @return KErrNone is the operation was successful. |
334 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
334 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
358 /** |
358 /** |
359 * Get the value for a location field of data type TReal32 from the |
359 * Get the value for a location field of data type TReal32 from the |
360 * HPositionGenericInfo. |
360 * HPositionGenericInfo. |
361 * @param aFieldId Id of the field for which the value should be read from |
361 * @param aFieldId Id of the field for which the value should be read from |
362 * HPositionGenericInfo. |
362 * HPositionGenericInfo. |
363 * @param[out] aValue The object where the data from the |
363 * @param [out] aValue The object where the data from the |
364 * HPositionGenericInfo is returned. |
364 * HPositionGenericInfo is returned. |
365 * @param aInfo The HPositionGenericInfo object from where this field needs |
365 * @param aInfo The HPositionGenericInfo object from where this field needs |
366 * to be read. |
366 * to be read. |
367 * @return KErrNone is the operation was successful. |
367 * @return KErrNone is the operation was successful. |
368 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
368 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
392 /** |
392 /** |
393 * Get the value for a location field of data type TReal64 from the |
393 * Get the value for a location field of data type TReal64 from the |
394 * HPositionGenericInfo. |
394 * HPositionGenericInfo. |
395 * @param aFieldId Id of the field for which the value should be read from |
395 * @param aFieldId Id of the field for which the value should be read from |
396 * HPositionGenericInfo. |
396 * HPositionGenericInfo. |
397 * @param[out] aValue The object where the data from the |
397 * @param [out] aValue The object where the data from the |
398 * HPositionGenericInfo is returned. |
398 * HPositionGenericInfo is returned. |
399 * @param aInfo The HPositionGenericInfo object from where this field needs |
399 * @param aInfo The HPositionGenericInfo object from where this field needs |
400 * to be read. |
400 * to be read. |
401 * @return KErrNone is the operation was successful. |
401 * @return KErrNone is the operation was successful. |
402 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
402 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
426 /** |
426 /** |
427 * Get the value for a location field of data type TDes8 from the |
427 * Get the value for a location field of data type TDes8 from the |
428 * HPositionGenericInfo. |
428 * HPositionGenericInfo. |
429 * @param aFieldId Id of the field for which the value should be read from |
429 * @param aFieldId Id of the field for which the value should be read from |
430 * HPositionGenericInfo. |
430 * HPositionGenericInfo. |
431 * @param[out] aValue The object where the data from the |
431 * @param [out] aValue The object where the data from the |
432 * HPositionGenericInfo is returned. |
432 * HPositionGenericInfo is returned. |
433 * @param aInfo The HPositionGenericInfo object from where this field needs |
433 * @param aInfo The HPositionGenericInfo object from where this field needs |
434 * to be read. |
434 * to be read. |
435 * @return KErrNone is the operation was successful. |
435 * @return KErrNone is the operation was successful. |
436 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
436 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
460 /** |
460 /** |
461 * Get the value for a location field of data type TDes16 from the |
461 * Get the value for a location field of data type TDes16 from the |
462 * HPositionGenericInfo. |
462 * HPositionGenericInfo. |
463 * @param aFieldId Id of the field for which the value should be read from |
463 * @param aFieldId Id of the field for which the value should be read from |
464 * HPositionGenericInfo. |
464 * HPositionGenericInfo. |
465 * @param[out] aValue The object where the data from the |
465 * @param [out] aValue The object where the data from the |
466 * HPositionGenericInfo is returned. |
466 * HPositionGenericInfo is returned. |
467 * @param aInfo The HPositionGenericInfo object from where this field needs |
467 * @param aInfo The HPositionGenericInfo object from where this field needs |
468 * to be read. |
468 * to be read. |
469 * @return KErrNone is the operation was successful. |
469 * @return KErrNone is the operation was successful. |
470 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
470 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
476 /** |
476 /** |
477 * Get the value for a location field of data type TPtrC8 from the |
477 * Get the value for a location field of data type TPtrC8 from the |
478 * HPositionGenericInfo. |
478 * HPositionGenericInfo. |
479 * @param aFieldId Id of the field for which the value should be read from |
479 * @param aFieldId Id of the field for which the value should be read from |
480 * HPositionGenericInfo. |
480 * HPositionGenericInfo. |
481 * @param[out] aValue The object where the data from the |
481 * @param [out] aValue The object where the data from the |
482 * HPositionGenericInfo is returned. |
482 * HPositionGenericInfo is returned. |
483 * @param aInfo The HPositionGenericInfo object from where this field needs |
483 * @param aInfo The HPositionGenericInfo object from where this field needs |
484 * to be read. |
484 * to be read. |
485 * @return KErrNone is the operation was successful. |
485 * @return KErrNone is the operation was successful. |
486 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
486 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
492 /** |
492 /** |
493 * Get the value for a location field of data type TPtrC16 from the |
493 * Get the value for a location field of data type TPtrC16 from the |
494 * HPositionGenericInfo. |
494 * HPositionGenericInfo. |
495 * @param aFieldId Id of the field for which the value should be read from |
495 * @param aFieldId Id of the field for which the value should be read from |
496 * HPositionGenericInfo. |
496 * HPositionGenericInfo. |
497 * @param[out] aValue The object where the data from the |
497 * @param [out] aValue The object where the data from the |
498 * HPositionGenericInfo is returned. |
498 * HPositionGenericInfo is returned. |
499 * @param aInfo The HPositionGenericInfo object from where this field needs |
499 * @param aInfo The HPositionGenericInfo object from where this field needs |
500 * to be read. |
500 * to be read. |
501 * @return KErrNone is the operation was successful. |
501 * @return KErrNone is the operation was successful. |
502 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
502 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
526 /** |
526 /** |
527 * Get the value for a location field of data type TTime from the |
527 * Get the value for a location field of data type TTime from the |
528 * HPositionGenericInfo. |
528 * HPositionGenericInfo. |
529 * @param aFieldId Id of the field for which the value should be read from |
529 * @param aFieldId Id of the field for which the value should be read from |
530 * HPositionGenericInfo. |
530 * HPositionGenericInfo. |
531 * @param[out] aValue The object where the data from the |
531 * @param [out] aValue The object where the data from the |
532 * HPositionGenericInfo is returned. |
532 * HPositionGenericInfo is returned. |
533 * @param aInfo The HPositionGenericInfo object from where this field needs |
533 * @param aInfo The HPositionGenericInfo object from where this field needs |
534 * to be read. |
534 * to be read. |
535 * @return KErrNone is the operation was successful. |
535 * @return KErrNone is the operation was successful. |
536 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
536 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
560 /** |
560 /** |
561 * Get the value for a location field of data type TTimeIntervalMicroSeconds from the |
561 * Get the value for a location field of data type TTimeIntervalMicroSeconds from the |
562 * HPositionGenericInfo. |
562 * HPositionGenericInfo. |
563 * @param aFieldId Id of the field for which the value should be read from |
563 * @param aFieldId Id of the field for which the value should be read from |
564 * HPositionGenericInfo. |
564 * HPositionGenericInfo. |
565 * @param[out] aValue The object where the data from the |
565 * @param [out] aValue The object where the data from the |
566 * HPositionGenericInfo is returned. |
566 * HPositionGenericInfo is returned. |
567 * @param aInfo The HPositionGenericInfo object from where this field needs |
567 * @param aInfo The HPositionGenericInfo object from where this field needs |
568 * to be read. |
568 * to be read. |
569 * @return KErrNone is the operation was successful. |
569 * @return KErrNone is the operation was successful. |
570 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
570 * @return KErrNotFound if an object with aFieldId cannot be found in aInfo. |
572 IMPORT_C static TInt GetValue(TPositionFieldId aFieldId, |
572 IMPORT_C static TInt GetValue(TPositionFieldId aFieldId, |
573 TTimeIntervalMicroSeconds& aValue, |
573 TTimeIntervalMicroSeconds& aValue, |
574 const HPositionGenericInfo& aInfo); |
574 const HPositionGenericInfo& aInfo); |
575 }; |
575 }; |
576 |
576 |
|
577 |
|
578 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS |
577 /** |
579 /** |
578 * This is an internal class used for indexing entries in HPositionGenericInfo. |
580 * This is an internal class used for indexing entries in HPositionGenericInfo. |
579 * Methods in this class are not intended to be called directly. Clients should use |
581 * Methods in this class are not intended to be called directly. Clients should use |
580 * HPositionGenericInfo::GetValue() and HPositionGenericInfo::SetValue() methods. |
582 * HPositionGenericInfo::GetValue() and HPositionGenericInfo::SetValue() methods. |
581 * @internalTechnology |
583 * @internalTechnology |
629 this index starts at. */ |
631 this index starts at. */ |
630 TUint16 iFieldStartPos; |
632 TUint16 iFieldStartPos; |
631 /** Type of the data that this index refers to. */ |
633 /** Type of the data that this index refers to. */ |
632 PositionFieldManager::TFieldType iFieldType; |
634 PositionFieldManager::TFieldType iFieldType; |
633 }; |
635 }; |
|
636 #endif // SYMBIAN_ENABLE_SPLIT_HEADERS |
634 |
637 |
635 #endif //__LBSFIELDS_H__ |
638 #endif //__LBSFIELDS_H__ |