Ubuntu Platform API  3.0.0
A library helping with tight integration into the Ubuntu platform
position_update.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Thomas Voß <thomas.voss@canonical.com>
17  */
18 
19 #ifndef UBUNTU_APPLICATION_LOCATION_POSITION_UPDATE_H_
20 #define UBUNTU_APPLICATION_LOCATION_POSITION_UPDATE_H_
21 
22 #include <ubuntu/visibility.h>
23 
24 #include <stdbool.h>
25 #include <stdint.h>
26 
27 #ifdef __cplusplus
28 extern "C"
29 {
30 #endif
31 
36  typedef struct UbuntuApplicationLocationPositionUpdate UALocationPositionUpdate;
37 
45  UALocationPositionUpdate *update);
46 
54  UALocationPositionUpdate *update);
55 
62  UBUNTU_DLL_PUBLIC uint64_t
64  UALocationPositionUpdate *update);
65 
72  UBUNTU_DLL_PUBLIC double
74  UALocationPositionUpdate *update);
75 
82  UBUNTU_DLL_PUBLIC double
84  UALocationPositionUpdate *update);
85 
94  UALocationPositionUpdate *update);
95 
102  UBUNTU_DLL_PUBLIC double
104  UALocationPositionUpdate *update);
105 
112  UBUNTU_DLL_PUBLIC bool
114  UALocationPositionUpdate *update);
115 
122  UBUNTU_DLL_PUBLIC double
124  UALocationPositionUpdate *update);
125 
132  UBUNTU_DLL_PUBLIC bool
134  UALocationPositionUpdate *update);
135 
142  UBUNTU_DLL_PUBLIC double
144  UALocationPositionUpdate *update);
145 
146 #ifdef __cplusplus
147 }
148 #endif
149 
150 #endif // UBUNTU_APPLICATION_LOCATION_POSITION_UPDATE_H_
ua_location_position_update_has_horizontal_accuracy
UBUNTU_DLL_PUBLIC bool ua_location_position_update_has_horizontal_accuracy(UALocationPositionUpdate *update)
Checks if the position update contains a horizontal accuracy estimate.
ua_location_position_update_get_altitude_in_meter
UBUNTU_DLL_PUBLIC double ua_location_position_update_get_altitude_in_meter(UALocationPositionUpdate *update)
Queries the altitude contained in the position update.
ua_location_position_update_get_latitude_in_degree
UBUNTU_DLL_PUBLIC double ua_location_position_update_get_latitude_in_degree(UALocationPositionUpdate *update)
Queries the latitude contained in the position update.
visibility.h
ua_location_position_update_has_altitude
UBUNTU_DLL_PUBLIC bool ua_location_position_update_has_altitude(UALocationPositionUpdate *update)
Checks if the position update contains an altitude.
ua_location_position_update_get_timestamp
UBUNTU_DLL_PUBLIC uint64_t ua_location_position_update_get_timestamp(UALocationPositionUpdate *update)
Queries the timestamp of the position update.
ua_location_position_update_get_longitude_in_degree
UBUNTU_DLL_PUBLIC double ua_location_position_update_get_longitude_in_degree(UALocationPositionUpdate *update)
Queries the longitude contained in the position update.
UBUNTU_DLL_PUBLIC
#define UBUNTU_DLL_PUBLIC
Definition: visibility.h:26
UALocationPositionUpdate
struct UbuntuApplicationLocationPositionUpdate UALocationPositionUpdate
Opaque type encapsulating a location update.
Definition: position_update.h:36
ua_location_position_update_has_vertical_accuracy
UBUNTU_DLL_PUBLIC bool ua_location_position_update_has_vertical_accuracy(UALocationPositionUpdate *update)
Checks if the position update contains a vertical accuracy estimate.
ua_location_position_update_ref
UBUNTU_DLL_PUBLIC void ua_location_position_update_ref(UALocationPositionUpdate *update)
Increments the reference count of the position update instance.
ua_location_position_update_unref
UBUNTU_DLL_PUBLIC void ua_location_position_update_unref(UALocationPositionUpdate *update)
Decrements the reference count of the position update instance.
ua_location_position_update_get_horizontal_accuracy_in_meter
UBUNTU_DLL_PUBLIC double ua_location_position_update_get_horizontal_accuracy_in_meter(UALocationPositionUpdate *update)
Queries the horizontal accuracy contained in the position update.
ua_location_position_update_get_vertical_accuracy_in_meter
UBUNTU_DLL_PUBLIC double ua_location_position_update_get_vertical_accuracy_in_meter(UALocationPositionUpdate *update)
Queries the vertical accuracy contained in the position update.