Make use of Doxygen grouping feature

Improve Modules page in generated HTML documentation
This commit is contained in:
Carles Fernandez 2020-11-01 13:37:19 +01:00
parent 73b909bac1
commit 287284261c
No known key found for this signature in database
GPG Key ID: 4C583C52B0C3877D
305 changed files with 2769 additions and 112 deletions

View File

@ -64,6 +64,8 @@ SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc
length sample types.
- Fixed the `obsdiff` and `rinex2assist` utilities when installed if they were
built with a locally downloaded version of GPSTk.
- The generated HTML documentation now makes use of the Doxygen grouping
feature.
- Improved rendering of equations in HTML documentation generated by Doxygen.
Make use of MathJax for equation rendering. Added new building option
`ENABLE_EXTERNAL_MATHJAX`, set to `ON` by default. If set to `OFF`, it allows

View File

@ -32,6 +32,13 @@
#include <map> // for map
#include <string> // for string
/** \addtogroup PVT
* Computation of Position, Velocity and Time from GNSS observables.
* \{ */
/** \addtogroup PVT_adapters pvt_adapters
* Wrap GNU Radio PVT solvers with a PvtInterface
* \{ */
class ConfigurationInterface;
class Galileo_Almanac;
class Galileo_Ephemeris;
@ -99,4 +106,6 @@ private:
unsigned int out_streams_;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_RTKLIB_PVT_H

View File

@ -41,6 +41,13 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_gnuradio_blocks pvt_gr_blocks
* GNU Radio blocks for the computation of PVT solutions.
* \{ */
class Beidou_Dnav_Almanac;
class Beidou_Dnav_Ephemeris;
class Galileo_Almanac;
@ -270,4 +277,7 @@ private:
bool d_rtcm_enabled;
};
/** \} */
/** \} */
#endif // GNSS_SDR_RTKLIB_PVT_GS_H

View File

@ -26,6 +26,12 @@
#include <fstream>
#include <string>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
class Pvt_Solution;
/*!
@ -49,4 +55,7 @@ private:
bool first_pos;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_GEOJSON_PRINTER_H

View File

@ -26,6 +26,12 @@
#include <fstream>
#include <string>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
class Pvt_Solution;
/*!
@ -50,4 +56,7 @@ private:
bool positions_printed;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_GPX_PRINTER_H

View File

@ -25,6 +25,12 @@
#include <fstream> // for ofstream
#include <string>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
class Pvt_Solution;
/*!
@ -52,4 +58,7 @@ private:
bool positions_printed;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_KML_PRINTER_H

View File

@ -23,6 +23,12 @@
#include <boost/serialization/nvp.hpp>
#include <cstdint>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
/*!
* \brief This class contains parameters and outputs of the PVT block
*/
@ -131,4 +137,7 @@ public:
}
};
/** \} */
/** \} */
#endif // GNSS_SDR_MONITOR_PVT_H

View File

@ -28,6 +28,12 @@
#include <string>
#include <vector>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
#if USE_BOOST_ASIO_IO_CONTEXT
using b_io_context = boost::asio::io_context;
#else
@ -50,4 +56,6 @@ private:
};
/** \} */
/** \} */
#endif // GNSS_SDR_MONITOR_PVT_UDP_SINK_H

View File

@ -30,6 +30,12 @@
#include <memory> // for shared_ptr
#include <string> // for string
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
class Rtklib_Solver;
/*!
@ -82,4 +88,7 @@ private:
bool d_flag_nmea_output_file;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_NMEA_PRINTER_H

View File

@ -24,6 +24,12 @@
#include <map>
#include <string>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
class Pvt_Conf
{
public:
@ -81,4 +87,7 @@ public:
bool dump_mat;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_PVT_CONF_H

View File

@ -25,6 +25,11 @@
#include <array>
#include <deque>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
/*!
* \brief Base class for a PVT solution
@ -120,4 +125,7 @@ private:
bool d_flag_averaging;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_PVT_SOLUTION_H

View File

@ -49,6 +49,13 @@
#include <sstream> // for stringstream
#include <string> // for string
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
class Beidou_Dnav_Ephemeris;
class Beidou_Dnav_Iono;
class Beidou_Dnav_Utc_Model;
@ -906,4 +913,6 @@ inline std::string Rinex_Printer::asString(const X x) const
}
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_RINEX_PRINTER_H

View File

@ -48,6 +48,12 @@
#include <utility>
#include <vector>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
#if USE_BOOST_ASIO_IO_CONTEXT
using b_io_context = boost::asio::io_context;
#else
@ -1466,4 +1472,7 @@ private:
int32_t set_DF420(const Gnss_Synchro& gnss_synchro);
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_RTCM_H

View File

@ -29,6 +29,12 @@
#include <memory> // std::shared_ptr
#include <string>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
class Galileo_Ephemeris;
class Glonass_Gnav_Ephemeris;
class Glonass_Gnav_Utc_Model;
@ -161,4 +167,7 @@ private:
bool d_rtcm_file_dump;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_RTCM_PRINTER_H

View File

@ -62,6 +62,12 @@
#include <map>
#include <string>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs pvt_libs
* Library for the computation of PVT solutions.
* \{ */
/*!
* \brief This class implements a PVT solution based on RTKLIB
@ -121,4 +127,7 @@ private:
bool d_flag_dump_mat_enabled;
};
/** \} */
/** \} */
#endif // GNSS_SDR_RTKLIB_SOLVER_H

View File

@ -27,6 +27,12 @@
#include <string>
#include <utility>
/** \addtogroup PVT
* \{ */
/** \addtogroup PVT_libs
* \{ */
/*!
* \brief This class implements serialization and deserialization of
* Monitor_Pvt objects using Protocol Buffers.
@ -152,4 +158,7 @@ private:
gnss_sdr::MonitorPvt monitor_{};
};
/** \} */
/** \} */
#endif // GNSS_SDR_SERDES_MONITOR_PVT_H

View File

@ -34,6 +34,11 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
@ -172,4 +177,7 @@ private:
unsigned int out_streams_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_BEIDOU_B1I_PCPS_ACQUISITION_H

View File

@ -33,6 +33,11 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
@ -171,4 +176,7 @@ private:
unsigned int out_streams_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_BEIDOU_B3I_PCPS_ACQUISITION_H

View File

@ -29,6 +29,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -165,4 +171,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E1_PCPS_8MS_AMBIGUOUS_ACQUISITION_H

View File

@ -31,6 +31,11 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
@ -179,4 +184,7 @@ private:
bool acquire_pilot_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E1_PCPS_AMBIGUOUS_ACQUISITION_H

View File

@ -29,6 +29,11 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
@ -201,4 +206,7 @@ private:
bool acquire_pilot_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E1_PCPS_AMBIGUOUS_ACQUISITION_FPGA_H

View File

@ -29,6 +29,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -166,4 +172,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E1_PCPS_CCCWSR_AMBIGUOUS_ACQUISITION_H

View File

@ -29,6 +29,11 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
@ -170,4 +175,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E1_PCPS_QUICKSYNC_AMBIGUOUS_ACQUISITION_H

View File

@ -29,6 +29,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -168,4 +174,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E1_PCPS_TONG_AMBIGUOUS_ACQUISITION_H

View File

@ -34,6 +34,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
class GalileoE5aNoncoherentIQAcquisitionCaf : public AcquisitionInterface
@ -174,4 +180,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E5A_NONCOHERENT_IQ_ACQUISITION_CAF_H

View File

@ -28,6 +28,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
class GalileoE5aPcpsAcquisition : public AcquisitionInterface
@ -168,4 +174,7 @@ private:
bool acq_iq_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E5A_PCPS_ACQUISITION_H

View File

@ -29,6 +29,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
@ -210,4 +216,7 @@ private:
bool acq_iq_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E5A_PCPS_ACQUISITION_FPGA_H

View File

@ -30,6 +30,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
class GalileoE5bPcpsAcquisition : public AcquisitionInterface
@ -206,4 +212,7 @@ private:
bool acq_iq_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E5B_PCPS_ACQUISITION_H

View File

@ -30,6 +30,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -211,4 +217,7 @@ private:
bool acq_iq_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E5B_PCPS_ACQUISITION_FPGA_H

View File

@ -33,6 +33,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -169,4 +175,7 @@ private:
unsigned int out_streams_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GLONASS_L1_CA_PCPS_ACQUISITION_H

View File

@ -32,6 +32,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -168,4 +174,7 @@ private:
unsigned int out_streams_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GLONASS_L2_CA_PCPS_ACQUISITION_H

View File

@ -35,6 +35,13 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* Classes for GNSS signal acquisition
* \{ */
/** \addtogroup Acq_adapters acquisition_adapters
* Wrap GNU Radio acquisition blocks with an AcquisitionInterface
* \{ */
class ConfigurationInterface;
@ -180,4 +187,7 @@ private:
unsigned int out_streams_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L1_CA_PCPS_ACQUISITION_H

View File

@ -36,6 +36,12 @@ using pcps_acquisition_fine_doppler_cc_sptr = std::shared_ptr<pcps_acquisition_f
using pcps_acquisition_fine_doppler_cc_sptr = boost::shared_ptr<pcps_acquisition_fine_doppler_cc>;
#endif
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -172,4 +178,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L1_CA_PCPS_ACQUISITION_FINE_DOPPLER_H

View File

@ -32,6 +32,11 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
@ -203,4 +208,7 @@ private:
unsigned int out_streams_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L1_CA_PCPS_ACQUISITION_FPGA_H

View File

@ -30,6 +30,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -163,4 +169,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L1_CA_PCPS_ASSISTED_ACQUISITION_H

View File

@ -29,6 +29,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -173,4 +179,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L1_CA_PCPS_OPENCL_ACQUISITION_H

View File

@ -31,6 +31,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -175,4 +181,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L1_CA_PCPS_QUICKSYNC_ACQUISITION_H

View File

@ -30,6 +30,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -170,4 +176,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L1_CA_TONG_ACQUISITION_H

View File

@ -32,6 +32,11 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
@ -178,4 +183,7 @@ private:
unsigned int num_codes_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L2_M_PCPS_ACQUISITION_H

View File

@ -31,6 +31,12 @@
#include <string> // for string
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class Gnss_Synchro;
class ConfigurationInterface;
@ -168,4 +174,7 @@ private:
unsigned int out_streams_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L2_M_PCPS_ACQUISITION_FPGA_H

View File

@ -32,6 +32,11 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
@ -178,4 +183,7 @@ private:
unsigned int num_codes_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L5I_PCPS_ACQUISITION_H

View File

@ -31,6 +31,12 @@
#include <string>
#include <vector>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -206,4 +212,7 @@ private:
unsigned int out_streams_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L5I_PCPS_ACQUISITION_FPGA_H

View File

@ -42,6 +42,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_gnuradio_blocks
* \{ */
class galileo_e5a_noncoherentIQ_acquisition_caf_cc;
#if GNURADIO_USES_STD_POINTERS
@ -266,4 +272,7 @@ private:
bool d_enable_monitor_output;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E5A_NONCOHERENT_IQ_ACQUISITION_CAF_CC_H

View File

@ -36,6 +36,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_gnuradio_blocks
* \{ */
class galileo_pcps_8ms_acquisition_cc;
#if GNURADIO_USES_STD_POINTERS
@ -236,4 +242,7 @@ private:
bool d_enable_monitor_output;
};
/** \} */
/** \} */
#endif // GNSS_SDR_PCPS_8MS_ACQUISITION_CC_H

View File

@ -76,6 +76,14 @@ namespace own = gsl;
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Acquisition
* Classes for GNSS signal acquisition
* \{ */
/** \addtogroup Acq_gnuradio_blocks acquisition_gr_blocks
* GNU Radio processing blocks for GNSS signal acquisition
* \{ */
class Gnss_Synchro;
class pcps_acquisition;
@ -289,4 +297,7 @@ private:
std::queue<Gnss_Synchro> d_monitor_queue;
};
/** \} */
/** \} */
#endif // GNSS_SDR_PCPS_ACQUISITION_H

View File

@ -60,6 +60,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_gnuradio_blocks
* \{ */
class pcps_acquisition_fine_doppler_cc;
#if GNURADIO_USES_STD_POINTERS
@ -246,4 +252,7 @@ private:
bool d_dump;
};
#endif /* pcps_acquisition_fine_doppler_cc*/
/** \} */
/** \} */
#endif // GNSS_SDR_PCPS_ACQUISITION_FINE_DOPPLER_CC_H

View File

@ -37,6 +37,12 @@
#include <memory> // for shared_ptr
#include <string> // for string
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_gnuradio_blocks
* \{ */
class Gnss_Synchro;
typedef struct
@ -230,4 +236,7 @@ private:
bool d_make_2_steps;
};
/** \} */
/** \} */
#endif // GNSS_SDR_PCPS_ACQUISITION_FPGA_H

View File

@ -52,6 +52,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_gnuradio_blocks
* \{ */
class pcps_assisted_acquisition_cc;
#if GNURADIO_USES_STD_POINTERS
@ -247,4 +253,7 @@ private:
bool d_enable_monitor_output;
};
/** \} */
/** \} */
#endif // GNSS_SDR_PCPS_ASSISTED_ACQUISITION_CC_H

View File

@ -41,6 +41,11 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_gnuradio_blocks
* \{ */
class pcps_cccwsr_acquisition_cc;
@ -235,4 +240,7 @@ private:
bool d_enable_monitor_output;
};
/** \} */
/** \} */
#endif // GNSS_SDR_PCPS_CCCWSR_ACQUISITION_CC_H

View File

@ -58,6 +58,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_gnuradio_blocks
* \{ */
class pcps_opencl_acquisition_cc;
#if GNURADIO_USES_STD_POINTERS
@ -296,4 +302,7 @@ private:
bool d_enable_monitor_output;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_PCPS_OPENCL_ACQUISITION_CC_H

View File

@ -58,6 +58,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_gnuradio_blocks
* \{ */
class pcps_quicksync_acquisition_cc;
#if GNURADIO_USES_STD_POINTERS
@ -267,4 +273,7 @@ private:
bool d_enable_monitor_output;
};
/** \} */
/** \} */
#endif // GNSS_SDR_PCPS_QUICKSYNC_ACQUISITION_CC_H

View File

@ -55,6 +55,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Acquisition
* \{ */
/** \addtogroup Acq_gnuradio_blocks
* \{ */
class pcps_tong_acquisition_cc;
#if GNURADIO_USES_STD_POINTERS
@ -250,4 +256,7 @@ private:
bool d_enable_monitor_output;
};
/** \} */
/** \} */
#endif // GNSS_SDR_PCPS_TONG_ACQUISITION_CC_H

View File

@ -25,6 +25,13 @@
#include <cstdint>
#include <string>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup acquisition_libs acquisition_libs
* Library with utilities for GNSS signal acquisition
* \{ */
class Acq_Conf
{
public:
@ -75,4 +82,7 @@ private:
void ConfigureAutomaticResampler(double opt_freq);
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_ACQ_CONF_H

View File

@ -28,6 +28,12 @@
#include <cstdint>
#include <string>
/** \addtogroup Acquisition
* \{ */
/** \addtogroup acquisition_libs
* \{ */
/*!
* \brief Class that implements carrier wipe-off and correlators.
*/
@ -169,4 +175,7 @@ private:
uint32_t d_PRN; // PRN
};
/** \} */
/** \} */
#endif // GNSS_SDR_FPGA_ACQUISITION_H

View File

@ -38,6 +38,16 @@
#include <mutex>
#include <string>
/** \addtogroup Channel
* Classes containing a GNSS channel.
* \{ */
/** \addtogroup Channel_adapters channel_adapters
* Classes that wrap an AcquisitionInterface,
* a TrackingInterface and a TelemetryDecoderInterface, and handles
* their interaction.
* \{ */
class ConfigurationInterface;
class AcquisitionInterface;
class TrackingInterface;
@ -46,7 +56,7 @@ class TelemetryDecoderInterface;
/*!
* \brief This class represents a GNSS channel. It wraps an AcquisitionInterface,
* a Tracking Interface and a TelemetryDecoderInterface, and handles
* a TrackingInterface and a TelemetryDecoderInterface, and handles
* their interaction through a Finite State Machine
*
*/
@ -104,4 +114,7 @@ private:
bool flag_enable_fpga_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_CHANNEL_H

View File

@ -31,6 +31,12 @@
#include <memory>
#include <mutex>
/** \addtogroup Channel
* \{ */
/** \addtogroup Channel_libs channel_libs
* Library with utilities for a GNSS Channel.
* \{ */
/*!
* \brief This class implements a State Machine for channel
@ -77,4 +83,7 @@ private:
uint32_t state_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_CHANNEL_FSM_H

View File

@ -29,6 +29,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Channel
* \{ */
/** \addtogroup Channel_libs
* \{ */
class channel_msg_receiver_cc;
#if GNURADIO_USES_STD_POINTERS
@ -55,4 +61,7 @@ private:
bool d_repeat; // todo: change FSM to include repeat value
};
/** \} */
/** \} */
#endif // GNSS_SDR_CHANNEL_MSG_RECEIVER_CC_H

View File

@ -28,6 +28,11 @@
#include <memory>
#include <string>
/** \addtogroup Signal_Conditioner
* \{ */
/** \addtogroup Signal_Conditioner_adapters
* \{ */
class ConfigurationInterface;
@ -70,4 +75,7 @@ private:
bool connected_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_SIGNAL_CONDITIONER_H

View File

@ -27,6 +27,14 @@
#include <memory>
#include <string>
/** \addtogroup Signal_Conditioner Signal Conditioner
* Signal Conditioner wrapper block
* \{ */
/** \addtogroup Signal_Conditioner_adapters conditioner_adapters
* Wrap a Signal Conditioner with a GNSSBlockInterface
* \{ */
/*!
* \brief This class wraps blocks to change data_type_adapter, input_filter and resampler
* to be applied to the input flow of sampled signal.
@ -66,4 +74,7 @@ private:
bool connected_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_SIGNAL_CONDITIONER_H

View File

@ -26,6 +26,14 @@
#include <cstdint>
#include <string>
/** \addtogroup Data_Type Data Type Adapters
* Classes for data type conversion
* \{ */
/** \addtogroup Data_type_adapters data_type_adapters
* Wrap GNU Radio data tyope adapter blocks with a GNSSBlockInterface
* \{ */
class ConfigurationInterface;
/*!
@ -74,4 +82,7 @@ private:
bool dump_;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_BYTE_TO_SHORT_H

View File

@ -28,6 +28,12 @@
#include <cstdint>
#include <string>
/** \addtogroup Data_Type
* \{ */
/** \addtogroup Data_type_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -78,4 +84,7 @@ private:
bool dump_;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_IBYTE_TO_CBYTE_H

View File

@ -27,6 +27,12 @@
#include <cstdint>
#include <string>
/** \addtogroup Data_Type
* \{ */
/** \addtogroup Data_type_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -77,4 +83,7 @@ private:
bool dump_;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_IBYTE_TO_COMPLEX_H

View File

@ -27,6 +27,11 @@
#include <cstdint>
#include <string>
/** \addtogroup Data_Type
* \{ */
/** \addtogroup Data_type_adapters
* \{ */
class ConfigurationInterface;
@ -78,4 +83,7 @@ private:
bool dump_;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_IBYTE_TO_CSHORT_H

View File

@ -27,6 +27,12 @@
#include <cstdint>
#include <string>
/** \addtogroup Data_Type
* \{ */
/** \addtogroup Data_type_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -77,4 +83,7 @@ private:
bool dump_;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_ISHORT_TO_COMPLEX_H

View File

@ -27,6 +27,11 @@
#include <cstdint>
#include <string>
/** \addtogroup Data_Type
* \{ */
/** \addtogroup Data_type_adapters
* \{ */
class ConfigurationInterface;
@ -78,4 +83,7 @@ private:
bool dump_;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_ISHORT_TO_CSHORT_H

View File

@ -27,6 +27,13 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Data_Type
* \{ */
/** \addtogroup data_type_gnuradio_blocks data_type_gr_blocks
* GNU Radio Blocks for data type conversion
* \{ */
class interleaved_byte_to_complex_byte;
#if GNURADIO_USES_STD_POINTERS
@ -53,4 +60,7 @@ private:
interleaved_byte_to_complex_byte();
};
/** \} */
/** \} */
#endif // GNSS_SDR_INTERLEAVED_BYTE_TO_COMPLEX_BYTE_H

View File

@ -27,6 +27,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Data_Type
* \{ */
/** \addtogroup data_type_gnuradio_blocks
* \{ */
class interleaved_byte_to_complex_short;
#if GNURADIO_USES_STD_POINTERS
@ -53,4 +59,7 @@ private:
interleaved_byte_to_complex_short();
};
/** \} */
/** \} */
#endif // GNSS_SDR_INTERLEAVED_BYTE_TO_COMPLEX_SHORT_H

View File

@ -27,6 +27,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Data_Type
* \{ */
/** \addtogroup data_type_gnuradio_blocks
* \{ */
class interleaved_short_to_complex_short;
#if GNURADIO_USES_STD_POINTERS
@ -53,4 +59,7 @@ private:
interleaved_short_to_complex_short();
};
/** \} */
/** \} */
#endif // GNSS_SDR_INTERLEAVED_SHORT_TO_COMPLEX_SHORT_H

View File

@ -26,6 +26,12 @@
#include <cstdint>
#include <string>
/** \addtogroup Input_Filter
* \{ */
/** \addtogroup Input_filter_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -75,4 +81,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_BEAMFORMER_FILTER_H

View File

@ -41,6 +41,14 @@
#include <string>
#include <vector>
/** \addtogroup Input_Filter Input Filter
* Classes for input signal filtering
* \{ */
/** \addtogroup Input_filter_adapters input_filter_adapters
* Classes that wrap GNU Radio input filters with a GNSSBlockInterface
* \{ */
class ConfigurationInterface;
/*!
@ -113,4 +121,7 @@ private:
bool dump_;
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_FIR_FILTER_H

View File

@ -38,6 +38,12 @@
#include <string>
#include <vector>
/** \addtogroup Input_Filter
* \{ */
/** \addtogroup Input_filter_adapters
* \{ */
class ConfigurationInterface;
/*!
@ -108,4 +114,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_FREQ_XLATING_FIR_FILTER_H

View File

@ -27,6 +27,12 @@
#include <string>
#include <vector>
/** \addtogroup Input_Filter
* \{ */
/** \addtogroup Input_filter_adapters
* \{ */
class ConfigurationInterface;
class NotchFilter : public GNSSBlockInterface
@ -71,4 +77,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_NOTCH_FILTER_H

View File

@ -27,6 +27,12 @@
#include <string>
#include <vector>
/** \addtogroup Input_Filter
* \{ */
/** \addtogroup Input_filter_adapters
* \{ */
class ConfigurationInterface;
class NotchFilterLite : public GNSSBlockInterface
@ -71,4 +77,7 @@ private:
bool dump_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_NOTCH_FILTER_LITE_H

View File

@ -31,6 +31,12 @@
#endif
#include <string>
/** \addtogroup Input_Filter
* \{ */
/** \addtogroup Input_filter_adapters
* \{ */
class ConfigurationInterface;
class PulseBlankingFilter : public GNSSBlockInterface
@ -78,4 +84,7 @@ private:
bool xlat_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_PULSE_BLANKING_FILTER_H

View File

@ -28,6 +28,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Input_Filter
* \{ */
/** \addtogroup Input_filter_gnuradio_blocks
* \{ */
class beamformer;
#if GNURADIO_USES_STD_POINTERS
@ -56,4 +62,7 @@ private:
std::vector<gr_complex> weight_vector = std::vector<gr_complex>(GNSS_SDR_BEAMFORMER_CHANNELS, gr_complex(1.0, 0.0));
};
/** \} */
/** \} */
#endif // GNSS_SDR_BEAMFORMER_H

View File

@ -17,8 +17,8 @@
* -----------------------------------------------------------------------------
*/
#ifndef GNSS_SDR_NOTCH_H
#define GNSS_SDR_NOTCH_H
#ifndef GNSS_SDR_NOTCH_CC_H
#define GNSS_SDR_NOTCH_CC_H
#if GNURADIO_USES_STD_POINTERS
#else
@ -30,6 +30,12 @@
#include <cstdint>
#include <memory>
/** \addtogroup Input_Filter
* \{ */
/** \addtogroup Input_filter_gnuradio_blocks
* \{ */
class Notch;
#if GNURADIO_USES_STD_POINTERS
@ -78,4 +84,7 @@ private:
bool filter_state_;
};
#endif // GNSS_SDR_NOTCH_H
/** \} */
/** \} */
#endif // GNSS_SDR_NOTCH_CC_H

View File

@ -17,8 +17,8 @@
* -----------------------------------------------------------------------------
*/
#ifndef GNSS_SDR_NOTCH_LITE_H
#define GNSS_SDR_NOTCH_LITE_H
#ifndef GNSS_SDR_NOTCH_LITE_CC_H
#define GNSS_SDR_NOTCH_LITE_CC_H
#if GNURADIO_USES_STD_POINTERS
#else
@ -30,6 +30,12 @@
#include <cstdint>
#include <memory>
/** \addtogroup Input_Filter
* \{ */
/** \addtogroup Input_filter_gnuradio_blocks
* \{ */
class NotchLite;
#if GNURADIO_USES_STD_POINTERS
@ -83,4 +89,7 @@ private:
bool filter_state_;
};
#endif // GNSS_SDR_NOTCH_LITE_H
/** \} */
/** \} */
#endif // GNSS_SDR_NOTCH_LITE_CC_H

View File

@ -17,8 +17,8 @@
* -----------------------------------------------------------------------------
*/
#ifndef GNSS_SDR_PULSE_BLANKING_H
#define GNSS_SDR_PULSE_BLANKING_H
#ifndef GNSS_SDR_PULSE_BLANKING_CC_H
#define GNSS_SDR_PULSE_BLANKING_CC_H
#if GNURADIO_USES_STD_POINTERS
#include <memory>
@ -29,6 +29,13 @@
#include <volk_gnsssdr/volk_gnsssdr_alloc.h> // for volk_gnsssdr::vector
#include <cstdint>
/** \addtogroup Input_Filter
* \{ */
/** \addtogroup Input_filter_gnuradio_blocks input_filter_gr_blocks
* GNU Radio blocks implementing input filters,
* \{ */
class pulse_blanking_cc;
#if GNURADIO_USES_STD_POINTERS
@ -66,4 +73,7 @@ private:
bool last_filtered_;
};
#endif // GNSS_SDR_PULSE_BLANKING_H
/** \} */
/** \} */
#endif // GNSS_SDR_PULSE_BLANKING_CC_H

View File

@ -31,6 +31,14 @@ namespace own = std;
namespace own = gsl;
#endif
/** \addtogroup Algorithms_Library Algorithms Common Library
* Common utilities for the GNSS receiver.
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* Common utilities for GNSS algorithms.
* \{ */
//! Generates int32_t GPS L1 C/A code for the desired SV ID and code shift
void beidou_b1i_code_gen_int(own::span<int32_t> _dest, int32_t _prn, uint32_t _chip_shift);
@ -46,4 +54,7 @@ void beidou_b1i_code_gen_complex_sampled(own::span<std::complex<float>> _dest, u
//! Generates complex GPS L1 C/A code for the desired SV ID and code shift
void beidou_b1i_code_gen_complex_sampled(own::span<std::complex<float>> _dest, uint32_t _prn, int32_t _fs, uint32_t _chip_shift);
/** \} */
/** \} */
#endif // GNSS_SDR_BEIDOU_B1I_SDR_SIGNAL_PROCESSING_H

View File

@ -31,6 +31,11 @@ namespace own = std;
namespace own = gsl;
#endif
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
//! Generates int BeiDou B3I code for the desired SV ID and code shift
void beidou_b3i_code_gen_int(own::span<int> _dest, int32_t _prn, uint32_t _chip_shift);
@ -47,4 +52,7 @@ void beidou_b3i_code_gen_complex_sampled(own::span<std::complex<float>> _dest, u
//! Generates complex BeiDou B3I code for the desired SV ID and code shift
void beidou_b3i_code_gen_complex_sampled(own::span<std::complex<float>> _dest, uint32_t _prn, int _fs, uint32_t _chip_shift);
/** \} */
/** \} */
#endif // GNSS_SDR_BEIDOU_B3I_SIGNAL_PROCESSING_H

View File

@ -29,6 +29,11 @@
#include <gnuradio/sync_block.h>
#include <gnuradio/types.h> // for gr_vector_const_void_star
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
class byte_x2_to_complex_byte;
#if GNURADIO_USES_STD_POINTERS
@ -56,4 +61,7 @@ private:
byte_x2_to_complex_byte();
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_BYTE_X2_TO_COMPLEX_BYTE_Hs

View File

@ -30,6 +30,12 @@
#include <gnuradio/sync_block.h>
#include <gnuradio/types.h> // for gr_vector_const_void_star
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
class complex_byte_to_float_x2;
#if GNURADIO_USES_STD_POINTERS
@ -56,4 +62,7 @@ private:
complex_byte_to_float_x2();
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_COMPLEX_BYTE_TO_FLOAT_X2_H

View File

@ -29,6 +29,11 @@
#include <gnuradio/sync_block.h>
#include <gnuradio/types.h> // for gr_vector_const_void_star
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
class complex_float_to_complex_byte;
@ -55,4 +60,7 @@ private:
complex_float_to_complex_byte();
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_COMPLEX_FLOAT_TO_COMPLEX_BYTE_H

View File

@ -29,6 +29,12 @@
#include <gnuradio/sync_block.h>
#include <gnuradio/types.h> // for gr_vector_const_void_star
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
class conjugate_cc;
#if GNURADIO_USES_STD_POINTERS
@ -55,4 +61,7 @@ private:
conjugate_cc();
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_CONJUGATE_CC_H

View File

@ -29,6 +29,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
class conjugate_ic;
#if GNURADIO_USES_STD_POINTERS
@ -55,4 +61,7 @@ private:
conjugate_ic();
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_CONJUGATE_IC_H

View File

@ -29,6 +29,12 @@
#include <gnuradio/sync_block.h>
#include <gnuradio/types.h> // for gr_vector_const_void_star
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
class conjugate_sc;
#if GNURADIO_USES_STD_POINTERS
@ -55,4 +61,7 @@ private:
conjugate_sc();
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_CONJUGATE_SC_H

View File

@ -30,6 +30,12 @@
#include <gnuradio/sync_block.h>
#include <gnuradio/types.h> // for gr_vector_const_void_star
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
class cshort_to_float_x2;
#if GNURADIO_USES_STD_POINTERS
@ -56,4 +62,7 @@ private:
cshort_to_float_x2();
};
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_CSHORT_TO_FLOAT_X2_H

View File

@ -32,6 +32,11 @@ namespace own = std;
namespace own = gsl;
#endif
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
/*!
* \brief This function generates Galileo E1 code (can select E1B or E1C sinboc).
@ -71,4 +76,7 @@ void galileo_e1_code_gen_complex_sampled(own::span<std::complex<float>> _dest, c
void galileo_e1_code_gen_complex_sampled(own::span<std::complex<float>> _dest, const std::array<char, 3>& _Signal,
bool _cboc, uint32_t _prn, int32_t _fs, uint32_t _chip_shift);
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E1_SIGNAL_PROCESSING_H

View File

@ -35,6 +35,12 @@ namespace own = std;
namespace own = gsl;
#endif
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
/*!
* \brief Generates Galileo E5a code at 1 sample/chip
*/
@ -72,4 +78,7 @@ void galileo_e5_b_code_gen_complex_sampled(own::span<std::complex<float>> _dest,
int32_t _fs,
uint32_t _chip_shift);
/** \} */
/** \} */
#endif // GNSS_SDR_GALILEO_E5_SIGNAL_PROCESSING_H

View File

@ -28,6 +28,12 @@
#include <armadillo>
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
arma::mat Skew_symmetric(const arma::vec &a); //!< Calculates skew-symmetric matrix
double WGS84_g0(double Lat_rad);
@ -175,4 +181,7 @@ double clsin(const arma::colvec &ar, int degree, double argument);
*/
void clksin(const arma::colvec &ar, int degree, double arg_real, double arg_imag, double *re, double *im);
/** \} */
/** \} */
#endif // GNSS_SDR_GEOFUNCTIONS_H

View File

@ -31,6 +31,12 @@ namespace own = std;
namespace own = gsl;
#endif
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
//! Generates complex GLONASS L1 C/A code for the desired SV ID and code shift, and sampled to specific sampling frequency
void glonass_l1_ca_code_gen_complex(own::span<std::complex<float>> _dest, uint32_t _chip_shift);
@ -40,4 +46,7 @@ void glonass_l1_ca_code_gen_complex_sampled(own::span<std::complex<float>> _dest
//! Generates complex GLONASS L1 C/A code for the desired SV ID and code shift
void glonass_l1_ca_code_gen_complex_sampled(own::span<std::complex<float>> _dest, int32_t _fs, uint32_t _chip_shift);
/** \} */
/** \} */
#endif // GNSS_SDR_GLONASS_SDR_SIGNAL_PROCESSING_H

View File

@ -31,6 +31,12 @@ namespace own = std;
namespace own = gsl;
#endif
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
//! Generates complex GLONASS L2 C/A code for the desired SV ID and code shift, and sampled to specific sampling frequency
void glonass_l2_ca_code_gen_complex(own::span<std::complex<float>> _dest, uint32_t _chip_shift);
@ -40,4 +46,7 @@ void glonass_l2_ca_code_gen_complex_sampled(own::span<std::complex<float>> _dest
//! Generates complex GLONASS L2 C/A code for the desired SV ID and code shift
void glonass_l2_ca_code_gen_complex_sampled(own::span<std::complex<float>> _dest, int32_t _fs, uint32_t _chip_shift);
/** \} */
/** \} */
#endif // GNSS_SDR_GLONASS_L2_SIGNAL_PROCESSING_H

View File

@ -24,6 +24,12 @@
#include <boost/circular_buffer.hpp>
#include <vector>
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
template <class T>
class Gnss_circular_deque
{
@ -136,4 +142,7 @@ void Gnss_circular_deque<T>::push_back(unsigned int ch, const T& new_data)
d_data[ch].push_back(new_data);
}
/** \} */
/** \} */
#endif // GNSS_SDR_CIRCULAR_DEQUE_H

View File

@ -23,6 +23,15 @@
#include <string>
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
bool gnss_sdr_create_directory(const std::string& foldername);
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_GNSS_SDR_CREATE_DIRECTORY_H

View File

@ -18,13 +18,20 @@
* -----------------------------------------------------------------------------
*/
#ifndef GNSS_SDR_FLAGS_H
#define GNSS_SDR_FLAGS_H
#ifndef GNSS_SDR_GNSS_SDR_FLAGS_H
#define GNSS_SDR_GNSS_SDR_FLAGS_H
#include <gflags/gflags.h>
#include <cstdint>
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Gflags gnss_sdr_flags
* Library for command-line handling.
* \{ */
DECLARE_string(c); //!< Path to the configuration file.
DECLARE_string(config_file); //!< Path to the configuration file.
@ -56,4 +63,7 @@ const int32_t DEFAULT_CARRIER_SMOOTHING_FACTOR = 200;
DECLARE_string(RINEX_version); //!< If defined, specifies the RINEX version (2.11 or 3.02). Overrides the configuration file.
DECLARE_string(RINEX_name); //!< If defined, specifies the RINEX files base name
#endif
/** \} */
/** \} */
#endif // GNSS_SDR_GNSS_SDR_FLAGS_H

View File

@ -31,6 +31,12 @@
#include <type_traits>
#include <utility>
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
namespace std
{
template <class T>
@ -73,4 +79,7 @@ make_unique(Args&&...) = delete;
#endif // __cplusplus == 201103L
/** \} */
/** \} */
#endif // GNSS_SDR_GNSS_SDR_MAKE_UNIQUE_H

View File

@ -33,6 +33,12 @@ namespace own = std;
namespace own = gsl;
#endif
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
/*!
* \brief This function generates a complex exponential in _dest.
*
@ -66,4 +72,7 @@ void resampler(const own::span<float> _from, own::span<float> _dest,
void resampler(own::span<const std::complex<float>> _from, own::span<std::complex<float>> _dest,
float _fs_in, float _fs_out);
/** \} */
/** \} */
#endif // GNSS_SDR_GNSS_SIGNAL_PROCESSING_H

View File

@ -31,6 +31,12 @@ namespace own = std;
namespace own = gsl;
#endif
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
//! Generates complex GPS L2C M code for the desired SV ID
void gps_l2c_m_code_gen_complex(own::span<std::complex<float>> _dest, uint32_t _prn);
void gps_l2c_m_code_gen_float(own::span<float> _dest, uint32_t _prn);
@ -38,4 +44,7 @@ void gps_l2c_m_code_gen_float(own::span<float> _dest, uint32_t _prn);
//! Generates complex GPS L2C M code for the desired SV ID, and sampled to specific sampling frequency
void gps_l2c_m_code_gen_complex_sampled(own::span<std::complex<float>> _dest, uint32_t _prn, int32_t _fs);
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L2C_SIGNAL_H

View File

@ -31,6 +31,12 @@ namespace own = std;
namespace own = gsl;
#endif
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
//! Generates complex GPS L5I code for the desired SV ID
void gps_l5i_code_gen_complex(own::span<std::complex<float>> _dest, uint32_t _prn);
@ -50,4 +56,6 @@ void gps_l5i_code_gen_complex_sampled(own::span<std::complex<float>> _dest, uint
void gps_l5q_code_gen_complex_sampled(own::span<std::complex<float>> _dest, uint32_t _prn, int32_t _fs);
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_L5_SIGNAL_H

View File

@ -31,6 +31,12 @@ namespace own = std;
namespace own = gsl;
#endif
/** \addtogroup Algorithms_Library
* \{ */
/** \addtogroup Algorithm_libs algorithms_libs
* \{ */
//! Generates int GPS L1 C/A code for the desired SV ID and code shift
void gps_l1_ca_code_gen_int(own::span<int32_t> _dest, int32_t _prn, uint32_t _chip_shift);
@ -46,4 +52,7 @@ void gps_l1_ca_code_gen_complex_sampled(own::span<std::complex<float>> _dest, ui
//! Generates complex GPS L1 C/A code for the desired SV ID and code shift
void gps_l1_ca_code_gen_complex_sampled(own::span<std::complex<float>> _dest, uint32_t _prn, int32_t _fs, uint32_t _chip_shift);
/** \} */
/** \} */
#endif // GNSS_SDR_GPS_SDR_SIGNAL_PROCESSING_H

Some files were not shown because too many files have changed in this diff Show More