GNU Radio Manual and C++ API Reference  3.7.4
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
dpll_bb.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007,2012 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_ANALOG_DPLL_BB_H
24 #define INCLUDED_ANALOG_DPLL_BB_H
25 
26 #include <gnuradio/analog/api.h>
27 #include <gnuradio/sync_block.h>
28 
29 namespace gr {
30  namespace analog {
31 
32  /*!
33  * \brief Detect the peak of a signal
34  * \ingroup peak_detectors_blk
35  *
36  * \details
37  * If a peak is detected, this block outputs a 1,
38  * or it outputs 0's.
39  */
40  class ANALOG_API dpll_bb : virtual public sync_block
41  {
42  public:
43  // gr::analog::dpll_bb::sptr
45 
46  static sptr make(float period, float gain);
47 
48  virtual void set_gain(float gain) = 0;
49  virtual void set_decision_threshold(float thresh) = 0;
50 
51  virtual float gain() const = 0;
52  virtual float freq() const = 0;
53  virtual float phase() const = 0;
54  virtual float decision_threshold() const = 0;
55  };
56 
57  } /* namespace analog */
58 } /* namespace gr */
59 
60 #endif /* INCLUDED_ANALOG_DPLL_BB_H */
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
boost::shared_ptr< dpll_bb > sptr
Definition: dpll_bb.h:44
Detect the peak of a signal.
Definition: dpll_bb.h:40
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30