mirrors
/
gnss-sdr
mirror of https://github.com/gnss-sdr/gnss-sdr
1
0
Fork 0
Code Issues Releases Wiki Activity

Fix headers and documentation

This commit is contained in:
Carles Fernandez 2018-04-20 13:20:10 +02:00
parent b4cb0cc76b
commit 2cd1bed90c
No known key found for this signature in database
GPG Key ID: 4C583C52B0C3877D
2 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/core/receiver/gnss_flowgraph.cc
View File

@ -1,12 +1,10 @@
/*!
* \file gnss_flowgraph.cc
* \brief Implementation of a GNSS receiver flowgraph
* \brief Implementation of a GNSS receiver flow graph
* \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
* Luis Esteve, 2012. luis(at)epsilon-formacion.com
* Carles Fernandez-Prades, 2014. cfernandez(at)cttc.es
*
* Detailed description of the file here if needed.
*
* -------------------------------------------------------------------------
*
* Copyright (C) 2010-2018 (see AUTHORS file for a list of contributors)
@ -95,7 +93,7 @@ void GNSSFlowgraph::stop()
void GNSSFlowgraph::connect()
{
// Connects the blocks in the flowgraph
// Connects the blocks in the flow graph
// Signal Source > Signal conditioner >> Channels >> Observables >> PVT
LOG(INFO) << "Connecting flowgraph";
@ -401,7 +399,7 @@ bool GNSSFlowgraph::send_telemetry_msg(pmt::pmt_t msg)
/*
* Applies an action to the flowgraph
* Applies an action to the flow graph
*
* \param[in] who Who generated the action
* \param[in] what What is the action 0: acquisition failed
@ -509,9 +507,9 @@ void GNSSFlowgraph::init()
{
std::cout << "Creating source " << i << std::endl;
sig_source_.push_back(block_factory_->GetSignalSource(configuration_, queue_, i));
//TODO: Create a class interface for SignalSources, derived from GNSSBlockInterface.
//Include GetRFChannels in the interface to avoid read config parameters here
//read the number of RF channels for each front-end
// TODO: Create a class interface for SignalSources, derived from GNSSBlockInterface.
// Include GetRFChannels in the interface to avoid read config parameters here
// read the number of RF channels for each front-end
RF_Channels = configuration_->property(sig_source_.at(i)->role() + ".RF_channels", 1);
std::cout << "RF Channels " << RF_Channels << std::endl;
for (int j = 0; j < RF_Channels; j++)
@ -523,11 +521,11 @@ void GNSSFlowgraph::init()
}
else
{
//backwards compatibility for old config files
// backwards compatibility for old config files
sig_source_.push_back(block_factory_->GetSignalSource(configuration_, queue_, -1));
//TODO: Create a class interface for SignalSources, derived from GNSSBlockInterface.
//Include GetRFChannels in the interface to avoid read config parameters here
//read the number of RF channels for each front-end
// TODO: Create a class interface for SignalSources, derived from GNSSBlockInterface.
// Include GetRFChannels in the interface to avoid read config parameters here
// read the number of RF channels for each front-end
RF_Channels = configuration_->property(sig_source_.at(0)->role() + ".RF_channels", 0);
if (RF_Channels != 0)
{
@ -539,7 +537,7 @@ void GNSSFlowgraph::init()
}
else
{
//old config file, single signal source and single channel, not specified
// old config file, single signal source and single channel, not specified
sig_conditioner_.push_back(block_factory_->GetSignalConditioner(configuration_, -1));
}
}
@ -566,7 +564,6 @@ void GNSSFlowgraph::init()
std::shared_ptr<std::vector<std::unique_ptr<GNSSBlockInterface>>> channels = block_factory_->GetChannels(configuration_, queue_);
//todo:check smart pointer coherence...
channels_count_ = channels->size();
for (unsigned int i = 0; i < channels_count_; i++)
{

21
src/core/receiver/gnss_flowgraph.h
View File

@ -1,12 +1,12 @@
/*!
* \file gnss_flowgraph.h
* \brief Interface of a GNSS receiver flowgraph.
* \brief Interface of a GNSS receiver flow graph.
* \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
* Luis Esteve, 2011. luis(at)epsilon-formacion.com
* Carles Fernandez-Prades, 2014. cfernandez(at)cttc.es
*
* It contains a signal source,
* a signal conditioner, a set of channels, a pvt and an output filter.
* a signal conditioner, a set of channels, an observables block and a pvt.
*
* -------------------------------------------------------------------------
*
@ -53,7 +53,7 @@ class ChannelInterface;
class ConfigurationInterface;
class GNSSBlockFactory;
/*! \brief This class represents a GNSS flowgraph.
/*! \brief This class represents a GNSS flow graph.
*
* It contains a signal source,
* a signal conditioner, a set of channels, a PVT and an output filter.
@ -62,7 +62,7 @@ class GNSSFlowgraph
{
public:
/*!
* \brief Constructor that initializes the receiver flowgraph
* \brief Constructor that initializes the receiver flow graph
*/
GNSSFlowgraph(std::shared_ptr<ConfigurationInterface> configuration, gr::msg_queue::sptr queue);
@ -71,14 +71,14 @@ public:
*/
virtual ~GNSSFlowgraph();
//! \brief Start the flowgraph
//! \brief Start the flow graph
void start();
//! \brief Stop the flowgraph
//! \brief Stop the flow graph
void stop();
/*!
* \brief Connects the defined blocks in the flowgraph
* \brief Connects the defined blocks in the flow graph
*
* Signal Source > Signal conditioner > Channels >> Observables >> PVT > Output filter
*/
@ -87,10 +87,10 @@ public:
void wait();
/*!
* \brief Applies an action to the flowgraph
* \brief Applies an action to the flow graph
*
* \param[in] who Who generated the action
* \param[in] what What is the action 0: acquisition failed
* \param[in] what What is the action. 0: acquisition failed; 1: acquisition success; 2: tracking lost
*/
void apply_action(unsigned int who, unsigned int what);
@ -100,14 +100,17 @@ public:
{
return applied_actions_;
}
bool connected()
{
return connected_;
}
bool running()
{
return running_;
}
/*!
* \brief Sends a GNURadio asynchronous message from telemetry to PVT
*