dpyGnss Namespace Reference

Deepsy Gnss namespace that includes the different enums, structs or method signatures that should be used.

Classes
struct	GnssStatus
	Defines the status information structure that is obtained within a GNSS STATUS. More...
struct	OdometerData

Typedefs
typedef boost::function< void(const bool &available)>	service_availability_handler
	Prototype of the handler function used to monitor service availability. More...
typedef boost::function< void(boost::system::error_code error_code, GnssPosition &last_position)>	get_position_handler_function
	Prototype of the handler function for getLastPosition method.
typedef boost::function< void(boost::system::error_code error_code, GnssPosition &next_position)>	get_periodic_position_handler_function
	Prototype of the handler function for setPositionSubscriberHandler method.
typedef boost::function< void(boost::system::error_code error_code, GnssStatus &current_status)>	get_gnss_status_handler_function
	Prototype of the handler function for setPositionSubscriberHandler method.
typedef boost::function< void(boost::system::error_code error_code, tm date)>	get_time_date_handler_function
	Prototype of the handler function for getStoredTimeDate method.
typedef boost::function< void(boost::system::error_code error_code, GnssInfo type, const std::string &value)>	get_info_handler_function
	Prototype of the handler function for getModemInfo method.
typedef boost::function< void(boost::system::error_code error_code, GnssPowerStatus pwr_stat)>	power_status_handler_function
	Prototype of the handler function for generateEventMsg method.
typedef boost::function< void(boost::system::error_code error_code, OdometerData &odometer_data)>	get_odometer_data_handler_function
	Prototype of the handler function for getOdometerData method.
typedef boost::function< void(boost::system::error_code error_code)>	result_handler_function
	Prototype of the handler function for obtaining result of the different operations.

Enumerations
enum	SimulationMode { PLAIN_TEXT_SIMULATION, NMEA_SIMULATION }
	Possible simulation modes. More...
enum	GnssPowerStatus { GNSS_DISABLED, GNSS_POWER_SAVE, GNSS_ON }
	Defines the possible GNSS POWER states that the gnss can be in. More...
enum	SwResetType { HOTSTART, WARMSTART, COLDSTART }
	Defines the possible ways of performing a GNSS Reset. More...
enum	AntenaStatus { ANTENNA_OFF, ANTENNA_SHORT_CIRCUIT, ANTENNA_NOT_DETECTED, ANTENNA_OK }
	Defines the possible status in which the antenna can be. More...
enum	GnssInfo { MANUFACTURER, MODEL, FW_VERSION, PROTOCOL_VERSION }
	Defines the possible information that can be queried. More...

Typedef Documentation

typedef boost::function<void(const bool &available)> service_availability_handler

Parameters

available

true if the service is available, false otherwise

Enumeration Type Documentation

enum AntenaStatus

Remarks

Note that it is not possible to detect the antenna presence in every equipment, as it depends on the hardware. Therefore, the value for AntenaStatus::ANTENNA_OK does not have the same meaning for every equipment.

In order to understand the meaning of AntenaStatus::ANTENNA_OK, please attend the following table:

Equipment	ANTENNA OK interpretation
EP100	Antenna enabled and detected
UC100/RMDT100	Antenna enabled (may be present or not)
TV10	Not applicable

Enumerator
ANTENNA_OFF	Antenna voltage supply is disabled.
ANTENNA_SHORT_CIRCUIT	Antenna problem detected : short circuit.
ANTENNA_NOT_DETECTED	No antenna has been detected.
ANTENNA_OK	Antenna has been enabled and has voltage supply. Check interpretation of this value in the documentation to know if the antenna has been detected or not.

enum GnssInfo

Enumerator
MANUFACTURER	Gnss Manufacturer.
MODEL	Gnss Model.
FW_VERSION	Gnss firmware version.
PROTOCOL_VERSION	Gnss protocol version used by the receiver.

enum GnssPowerStatus

Enumerator
GNSS_DISABLED	Gnss functions are not available.
GNSS_POWER_SAVE	Gnss low power consumption mode.
GNSS_ON	Gnss full functionality mode.

enum SimulationMode

Enumerator
PLAIN_TEXT_SIMULATION	Plain position text will be used to simulate positions.
NMEA_SIMULATION	NMEA format text will be used to simulate positions.

enum SwResetType

Enumerator
HOTSTART	Hot start reset.
WARMSTART	Warm start reset.
COLDSTART	Cold start reset.