1
0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2025-11-06 18:23:05 +00:00

improving documentation

git-svn-id: https://svn.code.sf.net/p/gnss-sdr/code/trunk@335 64b25241-fba3-4117-9849-534c7e92360d
This commit is contained in:
Carles Fernandez
2013-01-28 23:50:09 +00:00
parent b7802d99ef
commit ae1cb212de
24 changed files with 108 additions and 56 deletions

View File

@@ -1,7 +1,7 @@
/*!
* \file gps_l1_ca_tcp_connector_tracking.h
* \file galileo_e1_tcp_connector_tracking.h
* \brief Interface of an adapter of a TCP connector block based on code DLL + carrier PLL
* for GPS L1 C/A to a TrackingInterface
* for Galileo E1 to a TrackingInterface
* \author David Pubill, 2012. dpubill(at)cttc.es
* Luis Esteve, 2012. luis(at)epsilon-formacion.com
* Javier Arribas, 2011. jarribas(at)cttc.es
@@ -9,11 +9,11 @@
* Code DLL + carrier PLL according to the algorithms described in:
* K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.H.Jensen,
* A Software-Defined GPS and Galileo Receiver. A Single-Frequency
* Approach, Birkha user, 2007
* Approach, Birkhauser, 2007
*
* -------------------------------------------------------------------------
*
* Copyright (C) 2012 (see AUTHORS file for a list of contributors)
* Copyright (C) 2012-2013 (see AUTHORS file for a list of contributors)
*
* GNSS-SDR is a software defined Global Navigation
* Satellite Systems receiver
@@ -65,6 +65,7 @@ public:
{
return role_;
}
//! returns "Galileo_E1_TCP_CONNECTOR_Tracking"
std::string implementation()
{
return "Galileo_E1_TCP_CONNECTOR_Tracking";

View File

@@ -1,9 +1,9 @@
/*!
* \file gps_l1_ca_tcp_connector_tracking_cc.h
* \file galileo_e1_tcp_connector_tracking_cc.h
* \brief Interface of a TCP connector block based on code DLL + carrier PLL VEML (Very Early
* Minus Late) tracking block for Galileo E1 signals
* \author David Pubill, 2012. dpubill(at)cttc.es
* Luis Esteve, 2012. luis(at)epsilon-formacion.com
* Luis Esteve, 2012. luis(at)epsilon-formacion.com
* Javier Arribas, 2011. jarribas(at)cttc.es
*
* Code DLL + carrier PLL according to the algorithms described in:
@@ -13,7 +13,7 @@
*
* -------------------------------------------------------------------------
*
* Copyright (C) 2010-2012 (see AUTHORS file for a list of contributors)
* Copyright (C) 2010-2013 (see AUTHORS file for a list of contributors)
*
* GNSS-SDR is a software defined Global Navigation
* Satellite Systems receiver

View File

@@ -6,7 +6,7 @@
*
* -------------------------------------------------------------------------
*
* Copyright (C) 2010-2012 (see AUTHORS file for a list of contributors)
* Copyright (C) 2010-2013 (see AUTHORS file for a list of contributors)
*
* GNSS-SDR is a software defined Global Navigation
* Satellite Systems receiver
@@ -40,17 +40,19 @@
#define NUM_TX_VARIABLES_GPS_L1_CA 9
#define NUM_RX_VARIABLES 4
/*!
* \brief TCP communication class
*/
class tcp_communication
{
public:
tcp_communication();
~tcp_communication();
int listen_tcp_connection(size_t d_port_, size_t d_port_ch0_);
void send_receive_tcp_packet_galileo_e1(boost::array<float, NUM_TX_VARIABLES_GALILEO_E1> buf, tcp_packet_data *tcp_data_);
void send_receive_tcp_packet_gps_l1_ca(boost::array<float, NUM_TX_VARIABLES_GPS_L1_CA> buf, tcp_packet_data *tcp_data_);
void close_tcp_connection(size_t d_port_);
int listen_tcp_connection(size_t d_port_, size_t d_port_ch0_);
void send_receive_tcp_packet_galileo_e1(boost::array<float, NUM_TX_VARIABLES_GALILEO_E1> buf, tcp_packet_data *tcp_data_);
void send_receive_tcp_packet_gps_l1_ca(boost::array<float, NUM_TX_VARIABLES_GPS_L1_CA> buf, tcp_packet_data *tcp_data_);
void close_tcp_connection(size_t d_port_);
private:
boost::asio::io_service io_service_;

View File

@@ -1,6 +1,6 @@
/*!
* \file tcp_packet_data.h
* \brief Interface of the TCP packet data class
* \brief Interface of the TCP data packet class
* \author David Pubill, 2011. dpubill(at)cttc.es
*
*
@@ -32,6 +32,9 @@
#ifndef GNSS_SDR_TCP_PACKET_DATA_H_
#define GNSS_SDR_TCP_PACKET_DATA_H_
/*!
* \brief Class that implements a TCP data packet
*/
class tcp_packet_data
{
public: