mirror of https://github.com/gnss-sdr/gnss-sdr
108 lines
3.2 KiB
C++
108 lines
3.2 KiB
C++
/*!
|
|
* \file gnss_block_interface.h
|
|
* \brief This interface represents a GNSS block.
|
|
* \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
|
|
*
|
|
* Abstract class for GNSS block interfaces. Since all its methods are virtual,
|
|
* this class cannot be instantiated directly, and a subclass can only be
|
|
* instantiated directly if all inherited pure virtual methods have been
|
|
* implemented by that class or a parent class.
|
|
*
|
|
* -----------------------------------------------------------------------------
|
|
*
|
|
* GNSS-SDR is a Global Navigation Satellite System software-defined receiver.
|
|
* This file is part of GNSS-SDR.
|
|
*
|
|
* Copyright (C) 2010-2020 (see AUTHORS file for a list of contributors)
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
* -----------------------------------------------------------------------------
|
|
*/
|
|
|
|
|
|
#ifndef GNSS_SDR_GNSS_BLOCK_INTERFACE_H
|
|
#define GNSS_SDR_GNSS_BLOCK_INTERFACE_H
|
|
|
|
#include <gnuradio/top_block.h>
|
|
#include <cassert>
|
|
#include <string>
|
|
#include <utility> // for std::forward
|
|
|
|
/** \addtogroup Core
|
|
* \{ */
|
|
/** \addtogroup GNSS_Block_Interfaces
|
|
* \{ */
|
|
|
|
// clang-format off
|
|
#if GNURADIO_USES_STD_POINTERS
|
|
#include <memory>
|
|
template <typename T>
|
|
using gnss_shared_ptr = std::shared_ptr<T>;
|
|
template <typename C, typename... Args>
|
|
gnss_shared_ptr<C> gnss_make_shared(Args &&... args)
|
|
{
|
|
return std::make_shared<C>(std::forward<Args>(args)...);
|
|
}
|
|
#else
|
|
#include <boost/make_shared.hpp>
|
|
#include <boost/shared_ptr.hpp>
|
|
template <typename T>
|
|
using gnss_shared_ptr = boost::shared_ptr<T>;
|
|
template <typename C, typename... Args>
|
|
gnss_shared_ptr<C> gnss_make_shared(Args &&... args)
|
|
{
|
|
return boost::make_shared<C>(std::forward<Args>(args)...);
|
|
}
|
|
#endif
|
|
// clang-format on
|
|
|
|
|
|
/*!
|
|
* \brief This abstract class represents an interface to GNSS blocks.
|
|
*
|
|
* Abstract class for GNSS block interfaces. Since all its methods are virtual,
|
|
* this class cannot be instantiated directly, and a subclass can only be
|
|
* instantiated directly if all inherited pure virtual methods have been
|
|
* implemented by that class or a parent class.
|
|
*/
|
|
class GNSSBlockInterface
|
|
{
|
|
public:
|
|
virtual ~GNSSBlockInterface() = default;
|
|
virtual std::string role() = 0;
|
|
virtual std::string implementation() = 0;
|
|
virtual size_t item_size() = 0;
|
|
virtual void connect(gr::top_block_sptr top_block) = 0;
|
|
virtual void disconnect(gr::top_block_sptr top_block) = 0;
|
|
|
|
virtual gr::basic_block_sptr get_left_block() = 0;
|
|
virtual gr::basic_block_sptr get_right_block() = 0;
|
|
|
|
virtual gr::basic_block_sptr get_left_block(int RF_channel)
|
|
{
|
|
assert(RF_channel >= 0);
|
|
if (RF_channel == 0)
|
|
{
|
|
}; // avoid unused param warning
|
|
return nullptr; // added to support raw array access (non pure virtual to allow left unimplemented)= 0;
|
|
}
|
|
virtual gr::basic_block_sptr get_right_block(int RF_channel)
|
|
{
|
|
assert(RF_channel >= 0);
|
|
if (RF_channel == 0)
|
|
{
|
|
}; // avoid unused param warning
|
|
return nullptr; // added to support raw array access (non pure virtual to allow left unimplemented)= 0;
|
|
}
|
|
|
|
/*!
|
|
* \brief Start the flow of samples if needed.
|
|
*/
|
|
virtual void start(){};
|
|
};
|
|
|
|
|
|
/** \} */
|
|
/** \} */
|
|
#endif // GNSS_SDR_GNSS_BLOCK_INTERFACE_H
|