gnssApi.h

Go to the documentation of this file.

 
#pragma once
 
#include <boost/function.hpp>
#include <boost/system/error_code.hpp>
#include <boost/shared_ptr.hpp>
#include "gnssPosition.h"
#include <vector>
 
class GnssClient;
 
//To avoid redefinition in client and app
#ifndef GNSS_TYPES
#define GNSS_TYPES
 
namespace dpyGnss {
 
enum SimulationMode {
    PLAIN_TEXT_SIMULATION,      
    NMEA_SIMULATION           
};
 
enum GnssPowerStatus
{
    GNSS_DISABLED, 
    GNSS_POWER_SAVE, 
    GNSS_ON 
};
 
enum SwResetType
{
    HOTSTART, 
    WARMSTART, 
    COLDSTART 
};
 
 
enum AntenaStatus
{
    ANTENNA_OFF, 
    ANTENNA_SHORT_CIRCUIT, 
    ANTENNA_NOT_DETECTED, 
    ANTENNA_OK 
};
 
enum GnssInfo
{
    MANUFACTURER, 
    MODEL, 
    FW_VERSION, 
    PROTOCOL_VERSION 
};
 
struct GnssStatus
{
    GnssPowerStatus pwr_status; 
    AntenaStatus antenna_stat; 
    dpyGnssPosition::QualityIndicator fix_quality; 
    bool simulation_mode_active; 
};
 
struct OdometerData
{
    int distance; 
    int accuracy; 
    int total_distance; 
};
 
typedef boost::function<void(const bool &available)> service_availability_handler;
typedef boost::function<void(boost::system::error_code error_code, GnssPosition& last_position)> get_position_handler_function; 
typedef boost::function<void(boost::system::error_code error_code, GnssPosition& next_position)> get_periodic_position_handler_function; 
typedef boost::function<void(boost::system::error_code error_code, GnssStatus& current_status)> get_gnss_status_handler_function; 
typedef boost::function<void(boost::system::error_code error_code, tm date)> get_time_date_handler_function; 
typedef boost::function<void(boost::system::error_code error_code, GnssInfo type, const std::string& value)> get_info_handler_function; 
typedef boost::function<void(boost::system::error_code error_code, GnssPowerStatus pwr_stat)> power_status_handler_function; 
typedef boost::function<void(boost::system::error_code error_code, OdometerData& odometer_data)> get_odometer_data_handler_function; 
typedef boost::function<void(boost::system::error_code error_code, const std::string& key, const std::string& value)> get_configuration_parameter_handler_function; 
typedef boost::function<void(boost::system::error_code error_code)> result_handler_function; 
} //dpyGnss
#endif //GNSS_TYPES
 
 
class GnssObserver
{
public:
    virtual void NewPosition(const GnssPosition& position) = 0;
    virtual ~GnssObserver()
    {
    }
};
 
class Gnss
{
 
private:
    boost::shared_ptr<GnssClient> mClient; 
public:
 
    explicit Gnss(std::string ip = "127.0.0.1");
    virtual ~Gnss();
 
#ifndef TESTING
    bool isAlive();
    void monitorServiceAvailability_S(dpyGnss::service_availability_handler handler);
    void monitorServiceAvailability_U();
 
    //Asynchronous operations
    //From Deepsy 18.03
    void getPeriodicPosition_S(dpyGnss::get_periodic_position_handler_function handler);
    void getPeriodicPosition_U();
    void asyncSetPowerStatus(dpyGnss::GnssPowerStatus power_stat, dpyGnss::result_handler_function handler);
    void asyncGetPowerStatus(dpyGnss::power_status_handler_function handler);
    void asyncGetLastPosition(dpyGnss::get_position_handler_function handler);
    void asyncGetStoredTimeDate(dpyGnss::get_time_date_handler_function handler);
    void asyncGetModuleInfo(dpyGnss::GnssInfo info, dpyGnss::get_info_handler_function handler);
    void asyncPerformSoftwareReset(dpyGnss::SwResetType reset_type, dpyGnss::result_handler_function handler);
    void asyncPerformHardwareReset(dpyGnss::result_handler_function handler);
    
    //From Deepsy 18.10
    void asyncGetStatus(dpyGnss::get_gnss_status_handler_function handler);
    void getPeriodicStatus_S(dpyGnss::get_gnss_status_handler_function handler);
    void getPeriodicStatus_U();
    //    void getStatus(dpyGnss::get_gnss_status_handler_function handler);
 
    //Observer
    boost::system::error_code subscribe(GnssObserver *observer);
    boost::system::error_code unsubscribe(GnssObserver *observer);
 
    //Synchronous operations
    boost::system::error_code setPowerStatus(dpyGnss::GnssPowerStatus &power_stat);
    boost::system::error_code getPowerStatus(dpyGnss::GnssPowerStatus &pwr_stat);
    boost::system::error_code getLastPosition(GnssPosition &last_position);
    boost::system::error_code getStoredTimeDate(tm &gnssdatetime);
    boost::system::error_code getModuleInfo(dpyGnss::GnssInfo info, std::string& value);
    boost::system::error_code performSoftwareReset(dpyGnss::SwResetType reset_type);
    boost::system::error_code performHardwareReset();
 
    //From Deepsy 19.04
    void asyncStartSimulationMode(dpyGnss::SimulationMode simulation_type, std::string file_path,dpyGnss::result_handler_function handler);
    void asyncStopSimulationMode(dpyGnss::result_handler_function handler);
 
    //From Deepsy 22.20
    void asyncGetOdometerData(dpyGnss::get_odometer_data_handler_function handler);
 
    //From Deepsy 23.05
    void asyncSetConfigurationParameter(const std::string& key, const std::string& value, dpyGnss::result_handler_function handler);
    void asyncGetConfigurationParameter(const std::string& key, dpyGnss::get_configuration_parameter_handler_function handler);
    boost::system::error_code setConfigurationParameter(const std::string& key, const std::string& value);
    boost::system::error_code getConfigurationParameter(const std::string& key, std::string& value);
 
#else
    virtual bool isAlive();
    virtual void monitorServiceAvailability_S(dpyGnss::service_availability_handler handler);
    virtual void monitorServiceAvailability_U();
 
    virtual void getPeriodicPosition_S(dpyGnss::get_periodic_position_handler_function handler);
    virtual void getPeriodicPosition_U();
    virtual void asyncSetPowerStatus(dpyGnss::GnssPowerStatus power_stat, dpyGnss::result_handler_function handler);
    virtual void asyncGetPowerStatus(dpyGnss::power_status_handler_function handler);
    virtual void asyncGetLastPosition(dpyGnss::get_position_handler_function handler);
    virtual void asyncGetStoredTimeDate(dpyGnss::get_time_date_handler_function handler);
    virtual void asyncGetModuleInfo(dpyGnss::GnssInfo info, dpyGnss::get_info_handler_function handler);
    virtual void asyncPerformSoftwareReset(dpyGnss::SwResetType reset_type, dpyGnss::result_handler_function handler);
    virtual void asyncPerformHardwareReset(dpyGnss::result_handler_function handler);
    //From Deepsy 18.10
    virtual void asyncGetStatus(dpyGnss::get_gnss_status_handler_function handler);
    virtual void getPeriodicStatus_S(dpyGnss::get_gnss_status_handler_function handler);
    virtual void getPeriodicStatus_U();
 
    //    void getStatus(dpyGnss::get_gnss_status_handler_function handler);
 
    //Observer
    virtual boost::system::error_code subscribe(GnssObserver *observer);
    virtual boost::system::error_code unsubscribe(GnssObserver *observer);
 
    //Synchronous operations
    virtual boost::system::error_code setPowerStatus(dpyGnss::GnssPowerStatus &power_stat);
    virtual boost::system::error_code getPowerStatus(dpyGnss::GnssPowerStatus &pwr_stat);
    virtual boost::system::error_code getLastPosition(GnssPosition &last_position);
    virtual boost::system::error_code getStoredTimeDate(tm &gnssdatetime);
    virtual boost::system::error_code getModuleInfo(dpyGnss::GnssInfo info, std::string& value);
    virtual boost::system::error_code performSoftwareReset(dpyGnss::SwResetType reset_type);
    virtual boost::system::error_code performHardwareReset();
 
    //From Deepsy 19.04
    virtual void asyncStartSimulationMode(dpyGnss::SimulationMode simulation_type, std::string file_path,dpyGnss::result_handler_function handler);
    virtual void asyncStopSimulationMode(dpyGnss::result_handler_function handler);
 
    //From Deepsy 22.20
    virtual void asyncGetOdometerData(dpyGnss::get_odometer_data_handler_function handler); 
 
    //From Deepsy 23.05
    virtual void asyncSetConfigurationParameter(const std::string& key, const std::string& value, dpyGnss::result_handler_function handler);
    virtual void asyncGetConfigurationParameter(const std::string& key, dpyGnss::get_configuration_parameter_handler_function handler);
    virtual boost::system::error_code setConfigurationParameter(const std::string& key, const std::string& value);
    virtual boost::system::error_code getConfigurationParameter(const std::string& key, std::string& value);
#endif
};