include/grgsm/flow_control/burst_fnr_filter.h

/* -*- c++ -*- */
/*
 * @file
 * @author Roman Khassraf <rkhassraf@gmail.com>
 * @section LICENSE
 *
 * Gr-gsm is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * Gr-gsm is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with gr-gsm; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */


#ifndef INCLUDED_GSM_BURST_FNR_FILTER_H
#define INCLUDED_GSM_BURST_FNR_FILTER_H

#include <grgsm/api.h>
#include <gnuradio/block.h>

namespace gr {
  namespace gsm {

    enum filter_mode
    {
        FILTER_LESS_OR_EQUAL,
        FILTER_GREATER_OR_EQUAL
    };

    /*!
     * \brief <+description of block+>
     * \ingroup gsm
     *
     */
    class GRGSM_API burst_fnr_filter : virtual public gr::block
    {
     public:
      typedef boost::shared_ptr<burst_fnr_filter> sptr;

      /*!
       * \brief Return a shared_ptr to a new instance of gsm::burst_fnr_filter.
       *
       * To avoid accidental use of raw pointers, gsm::burst_fnr_filter's
       * constructor is in a private implementation
       * class. gsm::burst_fnr_filter::make is the public interface for
       * creating new instances.
       */
      static sptr make(filter_mode mode, unsigned int fnr);

      /* External API */
      virtual unsigned int get_fn(void) = 0;
      virtual unsigned int set_fn(unsigned int fn) = 0;

      virtual filter_mode get_mode(void) = 0;
      virtual filter_mode set_mode(filter_mode mode) = 0;
    };

  } // namespace gsm
} // namespace gr

#endif /* INCLUDED_GSM_BURST_FNR_FILTER_H */