channel_fsm.h

Go to the documentation of this file.

/*!
 * \file channel_fsm.h
 * \brief Interface of the State Machine for channel
 * \authors Javier Arribas, 2019. javiarribas@gmail.com
 *          Antonio Ramos, 2017. antonio.ramos(at)cttc.es
 *          Luis Esteve,   2011. luis(at)epsilon-formacion.com
 *
 * -----------------------------------------------------------------------------
 *
 * 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_CHANNEL_FSM_H
#define GNSS_SDR_CHANNEL_FSM_H
 
#include "acquisition_interface.h"
#include "concurrent_queue.h"
#include "telemetry_decoder_interface.h"
#include "tracking_interface.h"
#include <pmt/pmt.h>
#include <cstdint>
#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
 */
class ChannelFsm
{
public:
    ChannelFsm();
    virtual ~ChannelFsm() = default;
    explicit ChannelFsm(std::shared_ptr<AcquisitionInterface> acquisition);
 
    void set_acquisition(std::shared_ptr<AcquisitionInterface> acquisition);
    void set_tracking(std::shared_ptr<TrackingInterface> tracking);
    void set_telemetry(std::shared_ptr<TelemetryDecoderInterface> telemetry);
    void set_queue(Concurrent_Queue<pmt::pmt_t>* queue);
    void set_channel(uint32_t channel);
    void start_acquisition();
 
    // FSM EVENTS
    bool Event_start_acquisition();
    bool Event_start_acquisition_fpga();
    bool Event_stop_channel();
    bool Event_failed_tracking_standby();
    virtual bool Event_valid_acquisition();
    virtual bool Event_failed_acquisition_repeat();
    virtual bool Event_failed_acquisition_no_repeat();
 
private:
    void start_tracking();
    void stop_acquisition();
    void stop_tracking();
    void request_satellite();
    void notify_stop_tracking();
 
    std::shared_ptr<AcquisitionInterface> acq_;
    std::shared_ptr<TrackingInterface> trk_;
    std::shared_ptr<TelemetryDecoderInterface> nav_;
 
    std::mutex mx_;
 
    Concurrent_Queue<pmt::pmt_t>* queue_;
 
    uint32_t channel_;
    uint32_t state_;
};
 
 
/** \} */
/** \} */
#endif  // GNSS_SDR_CHANNEL_FSM_H