removed wrong contacts, added authors
[platform/core/location/lbs-location.git] / location / module / location-module.h
index af2d1f2..60f6ad9 100644 (file)
@@ -3,9 +3,6 @@
  *
  * Copyright (c) 2010-2013 Samsung Electronics Co., Ltd. All rights reserved.
  *
- * Contact: Youngae Kang <youngae.kang@samsung.com>, Minjune Kim <sena06.kim@samsung.com>
- *          Genie Kim <daejins.kim@samsung.com>
- *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -71,44 +68,41 @@ typedef void (*LocModSatelliteCB)(gboolean enabled, LocationSatellite *satellite
  * @brief This represents APIs declared in a GPS plug-in for location GPS modules.
  */
 typedef struct {
-       int (*start)(gpointer handle, guint pos_update_interval, LocModStatusCB status_cb, LocModPositionExtCB pos_ext_cb, LocModSatelliteCB sat_cb, gpointer userdata);  /*/< This is used for starting a GPS device from a plug-in. #LocModStatusCB, #LocModPositionExtCB are given from a location framework to a plug-in for asynchronous signaling. */
-       int (*start_batch)(gpointer handle, LocModBatchExtCB batch_ext_cb, guint batch_interval, guint batch_period, gpointer userdata);                                                                                        /*/< This is used for starting a GPS batch mode from a plug-in. #LocModBatchExtCB are given from a location framework to a plug-in for asynchronous signaling. */
-       int (*stop)(gpointer handle);                                                                                                  /*/< This is used for stopping a GPS device name from a plug-in. */
-       int (*stop_batch)(gpointer handle);                                                                                            /*/< This is used for stopping a GPS batch mode from a plug-in. */
-       int (*get_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);   /*/< This is used for getting a position from a plug-in. */
-       int (*get_last_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);   /*/< This is used for getting a last position from a plug-in. */
-       int (*get_nmea)(gpointer handle, gchar **nmea_data);                                                                           /*/< This is used for getting a nmea string from a plug-in. */
-       int (*get_satellite)(gpointer handle, LocationSatellite **satellite);                                                          /*/< This is used for getting a satellite information from a plug-in. */
-       int (*get_last_satellite)(gpointer handle, LocationSatellite **satellite);                                                     /*/< This is used for getting a last satellite information from a plug-in. */
+       int (*start)(gpointer handle, guint pos_update_interval, LocModStatusCB status_cb, LocModPositionExtCB pos_ext_cb, LocModSatelliteCB sat_cb, gpointer userdata);
+       int (*start_batch)(gpointer handle, LocModBatchExtCB batch_ext_cb, guint batch_interval, guint batch_period, gpointer userdata);
+       int (*stop)(gpointer handle);
+       int (*stop_batch)(gpointer handle);
+       int (*get_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);
+       int (*get_last_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);
+       int (*get_nmea)(gpointer handle, gchar **nmea_data);
+       int (*get_satellite)(gpointer handle, LocationSatellite **satellite);
+       int (*get_last_satellite)(gpointer handle, LocationSatellite **satellite);
        int (*set_option)(gpointer handle, const char *option);
        int (*set_position_update_interval)(gpointer handle, guint interval);
+       int (*set_mock_location)(gpointer handle, LocationPosition *position, LocationVelocity *velocity, LocationAccuracy *accuracy, LocModStatusCB status_cb, gpointer userdata);
+       int (*clear_mock_location)(gpointer handle, LocModStatusCB status_cb, gpointer userdata);
 } LocModGpsOps;
 
 /**
  * @brief This represents APIs declared in a WPS plug-in for location WPS modules.
  */
 typedef struct {
-       int (*start)(gpointer handle, LocModStatusCB status_cb, LocModPositionExtCB pos_ext_cb, gpointer userdata);   /*/< This is used for starting a WPS service from a plug-in. #LocModStatusCB, #LocModPositionExtCB and #LocModSatelliteCB(Not used) are given from a location framework to a plug-in for asynchronous signaling. */
-       int (*stop)(gpointer handle);                                                                                                   /*/< This is used for stopping a WPS service from a plug-in. */
-       int (*get_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);   /*/< This is used for getting a position from a plug-in. */
-       int (*get_last_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);   /*/< This is used for getting a last position from a plug-in. */
+       int (*start)(gpointer handle, LocModStatusCB status_cb, LocModPositionExtCB pos_ext_cb, gpointer userdata);
+       int (*stop)(gpointer handle);
+       int (*get_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);
+       int (*get_last_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);
        int (*set_option)(gpointer handle, const char *option);
+       int (*set_mock_location)(gpointer handle, LocationPosition *position, LocationVelocity *velocity, LocationAccuracy *accuracy, LocModStatusCB status_cb, gpointer userdata);
+       int (*clear_mock_location)(gpointer handle, LocModStatusCB status_cb, gpointer userdata);
 } LocModWpsOps;
 
 typedef struct {
-       int (*start)(gpointer handle, LocModStatusCB status_cb, LocModPositionExtCB pos_ext_cb, gpointer userdata);   /*/< This is used for starting a GPS device from a plug-in. #LocModStatusCB, #LocModPositionExtCB are given from a location framework to a plug-in for asynchronous signaling. */
-       int (*stop)(gpointer handle);   /*/< This is used for stopping a GPS device name from a plug-in. */
-#if 0 /* Mock doesn't support batch */
-       int (*start_batch)(gpointer handle, LocModBatchExtCB batch_ext_cb, guint batch_interval, guint batch_period, gpointer userdata);   /*/< This is used for starting a GPS batch mode from a plug-in. #LocModBatchExtCB are given from a location framework to a plug-in for asynchronous signaling. */
-       int (*stop_batch)(gpointer handle);   /*/< This is used for stopping a GPS batch mode from a plug-in. */
-#endif
-       int (*get_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);   /*/< This is used for getting a position from a plug-in. */
-       int (*get_last_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);   /*/< This is used for getting a last position from a plug-in. */
-       int (*set_option)(gpointer handle, const char *option);
-       /* int (*set_position_update_interval)(gpointer handle, guint interval); */
-       int (*set_mock_location)(gpointer handle, LocationPosition *position, LocationVelocity *velocity, LocationAccuracy *accuracy, LocModStatusCB status_cb, gpointer userdata);   /*/< This is used for getting a position from a plug-in. */
-       int (*clear_mock_location)(gpointer handle, LocModStatusCB status_cb, gpointer userdata);   /*/< This is used for getting a position from a plug-in. */
-} LocModMockOps;
+       int (*start)(gpointer handle, guint pos_update_interval, LocModStatusCB status_cb, LocModPositionExtCB pos_cb, LocModSatelliteCB sat_cb, gpointer userdata);
+       int (*stop)(gpointer handle);
+       int (*get_last_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);
+       int (*get_last_wps_position)(gpointer handle, LocationPosition **position, LocationVelocity **velocity, LocationAccuracy **accuracy);
+       int (*get_satellite)(gpointer handle, LocationSatellite **satellite);
+} LocModPassiveOps;
 
 /**
  * @brief This is used for exported APIs in a plug-in for a location framework.