GNU Radio's CDMA Package

switched_peak_detector_fb.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2016 <+YOU OR YOUR COMPANY+>.
4 *
5 * This is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3, or (at your option)
8 * any later version.
9 *
10 * This software is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this software; see the file COPYING. If not, write to
17 * the Free Software Foundation, Inc., 51 Franklin Street,
18 * Boston, MA 02110-1301, USA.
19 */
20
21
22#ifndef INCLUDED_CDMA_SWITCHED_PEAK_DETECTOR_FB_H
23#define INCLUDED_CDMA_SWITCHED_PEAK_DETECTOR_FB_H
24
25#include <cdma/api.h>
26#include <gnuradio/sync_block.h>
27
28 namespace gr {
29 namespace cdma {
30
31 /*!
32 * \brief <+description of block+>
33 * \ingroup cdma
34 *
35 */
36 class CDMA_API switched_peak_detector_fb : virtual public gr::sync_block
37 {
38 public:
39 typedef boost::shared_ptr<switched_peak_detector_fb> sptr;
40
41 /*!
42 * \brief Return a shared_ptr to a new instance of cdma::switched_peak_detector_fb.
43 *
44 * To avoid accidental use of raw pointers, cdma::switched_peak_detector_fb's
45 * constructor is in a private implementation
46 * class. cdma::switched_peak_detector_fb::make is the public interface for
47 * creating new instances.
48 */
49 static sptr make(float threshold_factor_rise = 0.25,
50 float threshold_factor_fall = 0.40,
51 int look_ahead = 10,
52 float alpha = 0.001,
53 int on = 1);
54
55 virtual void set_threshold_factor_rise(float thr) = 0;
56 virtual void set_threshold_factor_fall(float thr) = 0;
57 virtual void set_look_ahead(int look) = 0;
58 virtual void set_alpha(float alpha) = 0;
59 virtual void set_on(int on) = 0;
60 virtual float threshold_factor_rise() = 0;
61 virtual float threshold_factor_fall() = 0;
62 virtual int look_ahead() = 0;
63 virtual float alpha() = 0;
64 virtual int on() = 0;
65 };
66
67
68 } // namespace cdma
69} // namespace gr
70
71#endif /* INCLUDED_CDMA_SWITCHED_PEAK_DETECTOR_FB_H */
72
api.h
CDMA_API
#define CDMA_API
Definition: api.h:30
gr::cdma::switched_peak_detector_fb
<+description of block+>
Definition: switched_peak_detector_fb.h:37
gr::cdma::switched_peak_detector_fb::on
virtual int on()=0
gr::cdma::switched_peak_detector_fb::set_look_ahead
virtual void set_look_ahead(int look)=0
gr::cdma::switched_peak_detector_fb::sptr
boost::shared_ptr< switched_peak_detector_fb > sptr
Definition: switched_peak_detector_fb.h:39
gr::cdma::switched_peak_detector_fb::set_threshold_factor_fall
virtual void set_threshold_factor_fall(float thr)=0
gr::cdma::switched_peak_detector_fb::alpha
virtual float alpha()=0
gr::cdma::switched_peak_detector_fb::set_threshold_factor_rise
virtual void set_threshold_factor_rise(float thr)=0
gr::cdma::switched_peak_detector_fb::set_on
virtual void set_on(int on)=0
gr::cdma::switched_peak_detector_fb::look_ahead
virtual int look_ahead()=0
gr::cdma::switched_peak_detector_fb::threshold_factor_rise
virtual float threshold_factor_rise()=0
gr::cdma::switched_peak_detector_fb::threshold_factor_fall
virtual float threshold_factor_fall()=0
gr::cdma::switched_peak_detector_fb::make
static sptr make(float threshold_factor_rise=0.25, float threshold_factor_fall=0.40, int look_ahead=10, float alpha=0.001, int on=1)
Return a shared_ptr to a new instance of cdma::switched_peak_detector_fb.
gr::cdma::switched_peak_detector_fb::set_alpha
virtual void set_alpha(float alpha)=0
gr
Definition: amp_var_est.h:30