mirrors/gnss-sdr
1
0
Fork 0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2024-12-14 04:00:34 +00:00
Code Issues Releases Wiki Activity

Adding documentation

Browse Source
This commit is contained in:
Carles Fernandez 2014-04-15 15:03:54 +02:00
parent 46fb0ea214
commit e52206008a
1 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
src/core/receiver/control_thread.h
View File

@ -1,11 +1,11 @@
/*!
* \file control_thread.h
* \file control_thread.h
* \brief Interface of the receiver control plane
* \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
*
* GNSS Receiver Control Plane: connects the flowgraph, starts running it,
* and while it does not stop, reads the control messages generated by the blocks,
* process them, and apply the corresponding actions.
* processes them, and applies the corresponding actions.
*
* -------------------------------------------------------------------------
*
@ -19,7 +19,7 @@
* GNSS-SDR is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* at your option) any later version.
* (at your option) any later version.
*
* GNSS-SDR is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
@ -47,7 +47,10 @@ class ConfigurationInterface;
/*!
* \brief This class represents the main thread of the application, aka Control Thread.
* \brief This class represents the main thread of the application, so the name is ControlThread.
* This is the GNSS Receiver Control Plane: it connects the flowgraph, starts running it,
* and while it does not stop, reads the control messages generated by the blocks,
* processes them, and applies the corresponding actions.
*/
class ControlThread
{
@ -102,7 +105,7 @@ public:
/*!
* \brief Instantiates a flowgraph
*
* \return Returns a pointer to a flowgraph object
* \return Returns a smart pointer to a flowgraph object
*/
std::shared_ptr<GNSSFlowgraph> flowgraph()
{
@ -128,47 +131,53 @@ private:
void process_control_messages();
/*
* \brief Blocking function that reads the GPS ephemeris queue and updates the shared ephemeris map, accessible from the PVT block
* Blocking function that reads the GPS ephemeris queue and updates the shared ephemeris map, accessible from the PVT block
*/
void gps_ephemeris_data_collector();
/*
* \brief Writes the ephemeris map to a local XML file
* Writes the ephemeris map to a local XML file
*/
void gps_ephemeris_data_write_to_XML();
/*
* \brief Blocking function that reads the UTC model queue and updates the shared map, accessible from the PVT block
* Blocking function that reads the UTC model queue and updates the shared map, accessible from the PVT block
*/
void gps_utc_model_data_collector();
/*
* \brief Write the latest GPS UTC model to XML file
* Write the latest GPS UTC model to XML file
*/
void gps_utc_model_data_write_to_XML();
/*
* \brief Blocking function that reads the iono model queue and updates the shared map, accessible from the PVT block
* Blocking function that reads the iono model queue and updates the shared map, accessible from the PVT block
*/
void gps_iono_data_collector();
/*
* \brief Write the latest GPS IONO model to XML file
* Write the latest GPS IONO model to XML file
*/
void gps_iono_data_write_to_XML();
/*
* \brief Blocking function that reads the GPS assistance queue
* Blocking function that reads the GPS assistance queue
*/
void gps_acq_assist_data_collector();
/*
* \brief Blocking function that reads the Galileo ephemeris queue and updates the shared ephemeris map, accessible from the PVT block
* Blocking function that reads the Galileo ephemeris queue and updates the shared ephemeris map, accessible from the PVT block
*/
void galileo_ephemeris_data_collector();
/*
* \brief Blocking function that reads the UTC model queue and updates the shared map, accessible from the PVT block
*/
* Blocking function that reads the UTC model queue and updates the shared map, accessible from the PVT block
*/
void galileo_utc_model_data_collector();
/*
* Blocking function that reads the iono data queue and updates the shared map, accessible from the PVT block
*/
void galileo_iono_data_collector();
void apply_action(unsigned int what);
@ -182,6 +191,7 @@ private:
unsigned int processed_control_messages_;
unsigned int applied_actions_;
boost::thread keyboard_thread_;
boost::thread gps_ephemeris_data_collector_thread_;
boost::thread gps_iono_data_collector_thread_;
boost::thread gps_utc_model_data_collector_thread_;