le_pos_common.h

Go to the documentation of this file.
1 
2 /*
3  * ====================== WARNING ======================
4  *
5  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
6  * DO NOT MODIFY IN ANY WAY.
7  *
8  * ====================== WARNING ======================
9  */
10 /**
11  * @file le_pos_common.h
12  *
13  * Type definitions for le_pos.
14  *
15  */
16 #ifndef LE_POS_COMMON_H_INCLUDE_GUARD
17 #define LE_POS_COMMON_H_INCLUDE_GUARD
18 
19 
20 #include "legato.h"
21 
22 #define IFGEN_LE_POS_PROTOCOL_ID "c9b4a5b877bfe3915d5029d8393d9566"
23 #define IFGEN_LE_POS_MSG_SIZE 32
24 /** @addtogroup le_pos
25  * @{ **/
26 
27 
28 //--------------------------------------------------------------------------------------------------
29 /**
30  * Fix position states.
31  */
32 //--------------------------------------------------------------------------------------------------
33 typedef enum
34 {
36  ///< The position is not fixed.
38  ///< 2-Dimensional position fix.
40  ///< 3-Dimensional position fix.
42  ///< Estimated (i.e. forward predicted) position fix.
44  ///< Unknown state.
45 }
47 
48 
49 //--------------------------------------------------------------------------------------------------
50 /**
51  * Resolution values.
52  */
53 //--------------------------------------------------------------------------------------------------
54 typedef enum
55 {
57  ///< Resolution in meter.
59  ///< Resolution in decimeter.
61  ///< Resolution in centimeter.
63  ///< Resolution in millimeter.
65  ///< Unknown resolution.
66 }
68 
69 
70 //--------------------------------------------------------------------------------------------------
71 /**
72  * Reference type for dealing with Position samples.
73  */
74 //--------------------------------------------------------------------------------------------------
75 typedef struct le_pos_Sample* le_pos_SampleRef_t;
76 
77 
78 //--------------------------------------------------------------------------------------------------
79 /**
80  * Reference type used by Add/Remove functions for EVENT 'le_pos_Movement'
81  */
82 //--------------------------------------------------------------------------------------------------
83 typedef struct le_pos_MovementHandler* le_pos_MovementHandlerRef_t;
84 
85 
86 //--------------------------------------------------------------------------------------------------
87 /**
88  * Handler for movement changes that returns the reference of a reported position sample.
89  *
90  */
91 //--------------------------------------------------------------------------------------------------
92 typedef void (*le_pos_MovementHandlerFunc_t)
93 (
94  le_pos_SampleRef_t positionSampleRef,
95  ///< [OUT] Reference of the reported position sample.
96  void* contextPtr
97  ///<
98 );
99 
100 
101 //--------------------------------------------------------------------------------------------------
102 /**
103  * Get if this client bound locally.
104  */
105 //--------------------------------------------------------------------------------------------------
106 LE_SHARED bool ifgen_le_pos_HasLocalBinding
107 (
108  void
109 );
110 
111 
112 //--------------------------------------------------------------------------------------------------
113 /**
114  * Init data that is common across all threads
115  */
116 //--------------------------------------------------------------------------------------------------
117 LE_SHARED void ifgen_le_pos_InitCommonData
118 (
119  void
120 );
121 
122 
123 //--------------------------------------------------------------------------------------------------
124 /**
125  * Perform common initialization and open a session
126  */
127 //--------------------------------------------------------------------------------------------------
128 LE_SHARED le_result_t ifgen_le_pos_OpenSession
129 (
130  le_msg_SessionRef_t _ifgen_sessionRef,
131  bool isBlocking
132 );
133 
134 //--------------------------------------------------------------------------------------------------
135 /**
136  * Add handler function for EVENT 'le_pos_Movement'
137  *
138  * This event provides information on movement changes.
139  *
140  */
141 //--------------------------------------------------------------------------------------------------
142 LE_SHARED le_pos_MovementHandlerRef_t ifgen_le_pos_AddMovementHandler
143 (
144  le_msg_SessionRef_t _ifgen_sessionRef,
145  uint32_t horizontalMagnitude,
146  ///< [IN] Horizontal magnitude in meters.
147  ///< 0 means that I don't care about
148  ///< changes in the latitude and longitude.
149  uint32_t verticalMagnitude,
150  ///< [IN] Vertical magnitude in meters.
151  ///< 0 means that I don't care about
152  ///< changes in the altitude.
153  le_pos_MovementHandlerFunc_t handlerPtr,
154  ///< [IN]
155  void* contextPtr
156  ///< [IN]
157 );
158 
159 //--------------------------------------------------------------------------------------------------
160 /**
161  * Remove handler function for EVENT 'le_pos_Movement'
162  */
163 //--------------------------------------------------------------------------------------------------
164 LE_SHARED void ifgen_le_pos_RemoveMovementHandler
165 (
166  le_msg_SessionRef_t _ifgen_sessionRef,
167  le_pos_MovementHandlerRef_t handlerRef
168  ///< [IN]
169 );
170 
171 //--------------------------------------------------------------------------------------------------
172 /**
173  * Get the 2D location's data (Latitude, Longitude, Horizontal
174  * accuracy).
175  *
176  * @return LE_FAULT Function failed to get the 2D location's data
177  * @return LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX).
178  * @return LE_OK Function succeeded.
179  *
180  * @note latitudePtr, longitudePtr, hAccuracyPtr can be set to NULL if not needed.
181  */
182 //--------------------------------------------------------------------------------------------------
183 LE_SHARED le_result_t ifgen_le_pos_Get2DLocation
184 (
185  le_msg_SessionRef_t _ifgen_sessionRef,
186  int32_t* latitudePtr,
187  ///< [OUT] WGS84 Latitude in degrees, positive North [resolution 1e-6].
188  int32_t* longitudePtr,
189  ///< [OUT] WGS84 Longitude in degrees, positive East [resolution 1e-6].
190  int32_t* hAccuracyPtr
191  ///< [OUT] Horizontal position's accuracy in meters by default.
192 );
193 
194 //--------------------------------------------------------------------------------------------------
195 /**
196  * Get the 3D location's data (Latitude, Longitude, Altitude,
197  * Horizontal accuracy, Vertical accuracy).
198  *
199  * @return LE_FAULT Function failed to get the 3D location's data
200  * @return LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX).
201  * @return LE_OK Function succeeded.
202  *
203  * @note latitudePtr, longitudePtr,hAccuracyPtr, altitudePtr, vAccuracyPtr can be set to NULL
204  * if not needed.
205  */
206 //--------------------------------------------------------------------------------------------------
207 LE_SHARED le_result_t ifgen_le_pos_Get3DLocation
208 (
209  le_msg_SessionRef_t _ifgen_sessionRef,
210  int32_t* latitudePtr,
211  ///< [OUT] WGS84 Latitude in degrees, positive North [resolution 1e-6].
212  int32_t* longitudePtr,
213  ///< [OUT] WGS84 Longitude in degrees, positive East [resolution 1e-6].
214  int32_t* hAccuracyPtr,
215  ///< [OUT] Horizontal position's accuracy in meters by default.
216  int32_t* altitudePtr,
217  ///< [OUT] Altitude above Mean Sea Level in meters by default.
218  int32_t* vAccuracyPtr
219  ///< [OUT] Vertical position's accuracy in meters by default.
220 );
221 
222 //--------------------------------------------------------------------------------------------------
223 /**
224  * Get the time of the last updated location
225  *
226  * @return LE_FAULT Function failed to get the time.
227  * @return LE_OUT_OF_RANGE The retrieved time is invalid (all fields are set to 0).
228  * @return LE_OK Function succeeded.
229  *
230  */
231 //--------------------------------------------------------------------------------------------------
232 LE_SHARED le_result_t ifgen_le_pos_GetTime
233 (
234  le_msg_SessionRef_t _ifgen_sessionRef,
235  uint16_t* hoursPtr,
236  ///< [OUT] UTC Hours into the day [range 0..23].
237  uint16_t* minutesPtr,
238  ///< [OUT] UTC Minutes into the hour [range 0..59].
239  uint16_t* secondsPtr,
240  ///< [OUT] UTC Seconds into the minute [range 0..59].
241  uint16_t* millisecondsPtr
242  ///< [OUT] UTC Milliseconds into the second [range 0..999].
243 );
244 
245 //--------------------------------------------------------------------------------------------------
246 /**
247  * Get the date of the last updated location
248  *
249  * @return LE_FAULT Function failed to get the date.
250  * @return LE_OUT_OF_RANGE The retrieved date is invalid (all fields are set to 0).
251  * @return LE_OK Function succeeded.
252  *
253  */
254 //--------------------------------------------------------------------------------------------------
255 LE_SHARED le_result_t ifgen_le_pos_GetDate
256 (
257  le_msg_SessionRef_t _ifgen_sessionRef,
258  uint16_t* yearPtr,
259  ///< [OUT] UTC Year A.D. [e.g. 2014].
260  uint16_t* monthPtr,
261  ///< [OUT] UTC Month into the year [range 1...12].
262  uint16_t* dayPtr
263  ///< [OUT] UTC Days into the month [range 1...31].
264 );
265 
266 //--------------------------------------------------------------------------------------------------
267 /**
268  * Get the motion's data (Horizontal Speed, Horizontal Speed's
269  * accuracy, Vertical Speed, Vertical Speed's accuracy).
270  *
271  * @return LE_FAULT Function failed to get the motion's data.
272  * @return LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX,
273  * UINT32_MAX).
274  * @return LE_OK Function succeeded.
275  *
276  * @note hSpeedPtr, hSpeedAccuracyPtr, vSpeedPtr, vSpeedAccuracyPtr can be set to NULL if not
277  * needed.
278  */
279 //--------------------------------------------------------------------------------------------------
280 LE_SHARED le_result_t ifgen_le_pos_GetMotion
281 (
282  le_msg_SessionRef_t _ifgen_sessionRef,
283  uint32_t* hSpeedPtr,
284  ///< [OUT] Horizontal Speed in m/sec.
285  uint32_t* hSpeedAccuracyPtr,
286  ///< [OUT] Horizontal Speed's accuracy in m/sec.
287  int32_t* vSpeedPtr,
288  ///< [OUT] Vertical Speed in m/sec, positive up.
289  int32_t* vSpeedAccuracyPtr
290  ///< [OUT] Vertical Speed's accuracy in m/sec.
291 );
292 
293 //--------------------------------------------------------------------------------------------------
294 /**
295  * Get the heading indication.
296  *
297  * @return LE_FAULT Function failed to get the heading indication.
298  * @return LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to UINT32_MAX).
299  * @return LE_OK Function succeeded.
300  *
301  * @note Heading is given in degrees.
302  * Heading ranges from 0 to 359 degrees, where 0 is True North.
303  *
304  * @note headingPtr, headingAccuracyPtr can be set to NULL if not needed.
305  */
306 //--------------------------------------------------------------------------------------------------
307 LE_SHARED le_result_t ifgen_le_pos_GetHeading
308 (
309  le_msg_SessionRef_t _ifgen_sessionRef,
310  uint32_t* headingPtr,
311  ///< [OUT] Heading in degrees.
312  ///< Range: 0 to 359, where 0 is True North.
313  uint32_t* headingAccuracyPtr
314  ///< [OUT] Heading's accuracy in degrees.
315 );
316 
317 //--------------------------------------------------------------------------------------------------
318 /**
319  * Get the direction indication. Direction of movement is the direction that the vehicle or person
320  * is actually moving.
321  *
322  * @return LE_FAULT Function failed to get the direction indication.
323  * @return LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to UINT32_MAX).
324  * @return LE_OK Function succeeded.
325  *
326  * @note Direction is given in degrees.
327  * Direction ranges from 0 to 359 degrees, where 0 is True North.
328  *
329  * @note directionPtr, directionAccuracyPtr can be set to NULL if not needed.
330  */
331 //--------------------------------------------------------------------------------------------------
332 LE_SHARED le_result_t ifgen_le_pos_GetDirection
333 (
334  le_msg_SessionRef_t _ifgen_sessionRef,
335  uint32_t* directionPtr,
336  ///< [OUT] Direction indication in degrees.
337  ///< Range: 0 to 359, where 0 is True North.
338  uint32_t* directionAccuracyPtr
339  ///< [OUT] Direction's accuracy estimate in degrees.
340 );
341 
342 //--------------------------------------------------------------------------------------------------
343 /**
344  * Get the position fix state
345  *
346  * @return LE_FAULT Function failed to get the position fix state.
347  * @return LE_OK Function succeeded.
348  *
349  * @note In case the function fails to get the position fix state, a fatal error occurs,
350  * the function will not return.
351  */
352 //--------------------------------------------------------------------------------------------------
353 LE_SHARED le_result_t ifgen_le_pos_GetFixState
354 (
355  le_msg_SessionRef_t _ifgen_sessionRef,
356  le_pos_FixState_t* statePtr
357  ///< [OUT] Position fix state.
358 );
359 
360 //--------------------------------------------------------------------------------------------------
361 /**
362  * Get the position sample's 2D location (latitude, longitude,
363  * horizontal accuracy).
364  *
365  * @return LE_FAULT Function failed to find the positionSample.
366  * @return LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX).
367  * @return LE_OK Function succeeded.
368  *
369  * @note If the caller is passing an invalid Position reference into this function,
370  * it is a fatal error, the function will not return.
371  *
372  * @note latitudePtr, longitudePtr, horizontalAccuracyPtr can be set to NULL if not needed.
373  */
374 //--------------------------------------------------------------------------------------------------
375 LE_SHARED le_result_t ifgen_le_pos_sample_Get2DLocation
376 (
377  le_msg_SessionRef_t _ifgen_sessionRef,
378  le_pos_SampleRef_t positionSampleRef,
379  ///< [IN] Position sample's reference.
380  int32_t* latitudePtr,
381  ///< [OUT] WGS84 Latitude in degrees, positive North [resolution 1e-6].
382  int32_t* longitudePtr,
383  ///< [OUT] WGS84 Longitude in degrees, positive East [resolution 1e-6].
384  int32_t* horizontalAccuracyPtr
385  ///< [OUT] Horizontal position's accuracy in meters by default.
386 );
387 
388 //--------------------------------------------------------------------------------------------------
389 /**
390  * Get the position sample's time.
391  *
392  * @return LE_FAULT Function failed to get the time.
393  * @return LE_OUT_OF_RANGE The retrieved time is invalid (all fields are set to 0).
394  * @return LE_OK Function succeeded.
395  *
396  */
397 //--------------------------------------------------------------------------------------------------
398 LE_SHARED le_result_t ifgen_le_pos_sample_GetTime
399 (
400  le_msg_SessionRef_t _ifgen_sessionRef,
401  le_pos_SampleRef_t positionSampleRef,
402  ///< [IN] Position sample's reference.
403  uint16_t* hoursPtr,
404  ///< [OUT] UTC Hours into the day [range 0..23].
405  uint16_t* minutesPtr,
406  ///< [OUT] UTC Minutes into the hour [range 0..59].
407  uint16_t* secondsPtr,
408  ///< [OUT] UTC Seconds into the minute [range 0..59].
409  uint16_t* millisecondsPtr
410  ///< [OUT] UTC Milliseconds into the second [range 0..999].
411 );
412 
413 //--------------------------------------------------------------------------------------------------
414 /**
415  * Get the position sample's date.
416  *
417  * @return LE_FAULT Function failed to get the date.
418  * @return LE_OUT_OF_RANGE The retrieved date is invalid (all fields are set to 0).
419  * @return LE_OK Function succeeded.
420  *
421  */
422 //--------------------------------------------------------------------------------------------------
423 LE_SHARED le_result_t ifgen_le_pos_sample_GetDate
424 (
425  le_msg_SessionRef_t _ifgen_sessionRef,
426  le_pos_SampleRef_t positionSampleRef,
427  ///< [IN] Position sample's reference.
428  uint16_t* yearPtr,
429  ///< [OUT] UTC Year A.D. [e.g. 2014].
430  uint16_t* monthPtr,
431  ///< [OUT] UTC Month into the year [range 1...12].
432  uint16_t* dayPtr
433  ///< [OUT] UTC Days into the month [range 1...31].
434 );
435 
436 //--------------------------------------------------------------------------------------------------
437 /**
438  * Get the position sample's altitude.
439  *
440  * @return LE_FAULT Function failed to find the positionSample.
441  * @return LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX).
442  * @return LE_OK Function succeeded.
443  *
444  * @note If the caller is passing an invalid Position reference into this function,
445  * it is a fatal error, the function will not return.
446  *
447  * @note altitudePtr, altitudeAccuracyPtr can be set to NULL if not needed.
448  */
449 //--------------------------------------------------------------------------------------------------
450 LE_SHARED le_result_t ifgen_le_pos_sample_GetAltitude
451 (
452  le_msg_SessionRef_t _ifgen_sessionRef,
453  le_pos_SampleRef_t positionSampleRef,
454  ///< [IN] Position sample's reference.
455  int32_t* altitudePtr,
456  ///< [OUT] Altitude above Mean Sea Level in meters by default.
457  int32_t* altitudeAccuracyPtr
458  ///< [OUT] Vertical position's accuracy in meters by default.
459 );
460 
461 //--------------------------------------------------------------------------------------------------
462 /**
463  * Get the position sample's horizontal speed.
464  *
465  * @return LE_FAULT Function failed to find the positionSample.
466  * @return LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX,
467  * UINT32_MAX).
468  * @return LE_OK Function succeeded.
469  *
470  * @note If the caller is passing an invalid Position reference into this function,
471  * it is a fatal error, the function will not return.
472  *
473  * @note hSpeedPtr, hSpeedAccuracyPtr can be set to NULL if not needed.
474  */
475 //--------------------------------------------------------------------------------------------------
476 LE_SHARED le_result_t ifgen_le_pos_sample_GetHorizontalSpeed
477 (
478  le_msg_SessionRef_t _ifgen_sessionRef,
479  le_pos_SampleRef_t positionSampleRef,
480  ///< [IN] Position sample's reference.
481  uint32_t* hSpeedPtr,
482  ///< [OUT] The Horizontal Speed in m/sec.
483  uint32_t* hSpeedAccuracyPtr
484  ///< [OUT] The Horizontal Speed's accuracy in m/sec.
485 );
486 
487 //--------------------------------------------------------------------------------------------------
488 /**
489  * Get the position sample's vertical speed.
490  *
491  * @return LE_FAULT The function failed to find the positionSample.
492  * @return LE_OUT_OF_RANGE One of the retrieved parameter is not valid (set to INT32_MAX).
493  * @return LE_OK The function succeeded.
494  *
495  * @note If the caller is passing an invalid Position reference into this function,
496  * it is a fatal error, the function will not return.
497  *
498  * @note vSpeedPtr, vSpeedAccuracyPtr can be set to NULL if not needed.
499  */
500 //--------------------------------------------------------------------------------------------------
501 LE_SHARED le_result_t ifgen_le_pos_sample_GetVerticalSpeed
502 (
503  le_msg_SessionRef_t _ifgen_sessionRef,
504  le_pos_SampleRef_t positionSampleRef,
505  ///< [IN] Position sample's reference.
506  int32_t* vspeedPtr,
507  ///< [OUT] The Vertical Speed in m/sec, positive up.
508  int32_t* vspeedAccuracyPtr
509  ///< [OUT] The Vertical Speed's accuracy in m/sec.
510 );
511 
512 //--------------------------------------------------------------------------------------------------
513 /**
514  * Get the position sample's heading. Heading is the direction that the vehicle or person is facing.
515  *
516  * @return LE_FAULT Function failed to find the positionSample.
517  * @return LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to UINT32_MAX).
518  * @return LE_OK TFunction succeeded.
519  *
520  * @note Heading is given in degrees.
521  * Heading ranges from 0 to 359 degrees, where 0 is True North.
522  *
523  * @note If the caller is passing an invalid Position reference into this function,
524  * it is a fatal error, the function will not return.
525  *
526  * @note headingPtr, headingAccuracyPtr can be set to NULL if not needed.
527  */
528 //--------------------------------------------------------------------------------------------------
529 LE_SHARED le_result_t ifgen_le_pos_sample_GetHeading
530 (
531  le_msg_SessionRef_t _ifgen_sessionRef,
532  le_pos_SampleRef_t positionSampleRef,
533  ///< [IN] Position sample's reference.
534  uint32_t* headingPtr,
535  ///< [OUT] Heading in degrees.
536  ///< Range: 0 to 359, where 0 is True North.
537  uint32_t* headingAccuracyPtr
538  ///< [OUT] Heading's accuracy estimate in degrees.
539 );
540 
541 //--------------------------------------------------------------------------------------------------
542 /**
543  * Get the position sample's direction. Direction of movement is the direction that the vehicle or
544  * person is actually moving.
545  *
546  * @return LE_FAULT Function failed to find the positionSample.
547  * @return LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to UINT32_MAX).
548  * @return LE_OK Function succeeded.
549  *
550  * @note Direction is given in degrees.
551  * Direction ranges from 0 to 359 degrees, where 0 is True North.
552  *
553  * @note If the caller is passing an invalid Position reference into this function,
554  * it is a fatal error, the function will not return.
555  *
556  * @note directionPtr, directionAccuracyPtr can be set to NULL if not needed.
557  */
558 //--------------------------------------------------------------------------------------------------
559 LE_SHARED le_result_t ifgen_le_pos_sample_GetDirection
560 (
561  le_msg_SessionRef_t _ifgen_sessionRef,
562  le_pos_SampleRef_t positionSampleRef,
563  ///< [IN] Position sample's reference.
564  uint32_t* directionPtr,
565  ///< [OUT] Direction indication in degrees.
566  ///< Range: 0 to 359, where 0 is True North.
567  uint32_t* directionAccuracyPtr
568  ///< [OUT] Direction's accuracy estimate in degrees.
569 );
570 
571 //--------------------------------------------------------------------------------------------------
572 /**
573  * Get the position sample's fix state.
574  *
575  * @return LE_FAULT Function failed to get the position sample's fix state.
576  * @return LE_OK Function succeeded.
577  *
578  * @note If the caller is passing an invalid Position reference into this function,
579  * it is a fatal error, the function will not return.
580  */
581 //--------------------------------------------------------------------------------------------------
582 LE_SHARED le_result_t ifgen_le_pos_sample_GetFixState
583 (
584  le_msg_SessionRef_t _ifgen_sessionRef,
585  le_pos_SampleRef_t positionSampleRef,
586  ///< [IN] Position sample's reference.
587  le_pos_FixState_t* statePtr
588  ///< [OUT] Position fix state.
589 );
590 
591 //--------------------------------------------------------------------------------------------------
592 /**
593  * Release the position sample.
594  *
595  * @note If the caller is passing an invalid Position reference into this function,
596  * it is a fatal error, the function will not return.
597  */
598 //--------------------------------------------------------------------------------------------------
599 LE_SHARED void ifgen_le_pos_sample_Release
600 (
601  le_msg_SessionRef_t _ifgen_sessionRef,
602  le_pos_SampleRef_t positionSampleRef
603  ///< [IN] Position sample's reference.
604 );
605 
606 //--------------------------------------------------------------------------------------------------
607 /**
608  * Set the acquisition rate.
609  *
610  * @return
611  * LE_OUT_OF_RANGE Invalid acquisition rate.
612  * LE_OK The function succeeded.
613  */
614 //--------------------------------------------------------------------------------------------------
615 LE_SHARED le_result_t ifgen_le_pos_SetAcquisitionRate
616 (
617  le_msg_SessionRef_t _ifgen_sessionRef,
618  uint32_t acquisitionRate
619  ///< [IN] Acquisition rate in milliseconds.
620 );
621 
622 //--------------------------------------------------------------------------------------------------
623 /**
624  * Retrieve the acquisition rate.
625  *
626  * @return
627  * Acquisition rate in milliseconds.
628  */
629 //--------------------------------------------------------------------------------------------------
630 LE_SHARED uint32_t ifgen_le_pos_GetAcquisitionRate
631 (
632  le_msg_SessionRef_t _ifgen_sessionRef
633 );
634 
635 //--------------------------------------------------------------------------------------------------
636 /**
637  * Set the resolution for the positioning distance values.
638  *
639  * @return LE_OK Function succeeded.
640  * @return LE_BAD_PARAMETER Invalid parameter provided.
641  *
642  * @note The positioning distance values are: the altitude above sea level, the horizontal
643  * position accuracy and the vertical position accuracy. The API sets the same resolution to
644  * all distance values. The resolution change request takes effect immediately.
645  *
646  * @warning The positioning distance values resolutions are platform dependent. Please refer to
647  * @ref platformConstraintsPositioning_SettingResolution section for full details.
648  */
649 //--------------------------------------------------------------------------------------------------
650 LE_SHARED le_result_t ifgen_le_pos_SetDistanceResolution
651 (
652  le_msg_SessionRef_t _ifgen_sessionRef,
653  le_pos_Resolution_t resolution
654  ///< [IN] Resolution.
655 );
656 /** @} **/
657 #endif // LE_POS_COMMON_H_INCLUDE_GUARD
Unknown resolution.
Definition: le_pos_common.h:64
#define LE_SHARED
Definition: le_basics.h:300
Estimated (i.e. forward predicted) position fix.
Definition: le_pos_common.h:41
le_result_t
Definition: le_basics.h:46
2-Dimensional position fix.
Definition: le_pos_common.h:37
Resolution in millimeter.
Definition: le_pos_common.h:62
struct le_pos_Sample * le_pos_SampleRef_t
Definition: le_pos_common.h:75
le_pos_Resolution_t
Definition: le_pos_common.h:54
void(* le_pos_MovementHandlerFunc_t)(le_pos_SampleRef_t positionSampleRef, void *contextPtr)
Definition: le_pos_common.h:93
Resolution in centimeter.
Definition: le_pos_common.h:60
Resolution in meter.
Definition: le_pos_common.h:56
struct le_pos_MovementHandler * le_pos_MovementHandlerRef_t
Definition: le_pos_common.h:83
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
3-Dimensional position fix.
Definition: le_pos_common.h:39
The position is not fixed.
Definition: le_pos_common.h:35
le_pos_FixState_t
Definition: le_pos_common.h:33
Resolution in decimeter.
Definition: le_pos_common.h:58
Unknown state.
Definition: le_pos_common.h:43