GNU Radio's BLOCKSTREAM Package
nco_cc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2017 <+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_BLOCKSAT_NCO_CC_H
23 #define INCLUDED_BLOCKSAT_NCO_CC_H
24 
25 #include <blocksat/api.h>
26 #include <gnuradio/sync_block.h>
27 
28 namespace gr {
29  namespace blocksat {
30 
31  /*!
32  * \brief <+description of block+>
33  * \ingroup blocksat
34  *
35  */
36  class BLOCKSAT_API nco_cc : virtual public gr::sync_block
37  {
38  public:
39  typedef boost::shared_ptr<nco_cc> sptr;
40 
41  /*!
42  * \brief Return a shared_ptr to a new instance of blocksat::nco_cc.
43  *
44  * To avoid accidental use of raw pointers, blocksat::nco_cc's
45  * constructor is in a private implementation
46  * class. blocksat::nco_cc::make is the public interface for
47  * creating new instances.
48  */
49  static sptr make(float samp_rate, float freq, int n_steps);
50 
51  // Setters ready for parameter adjustment in runtime:
52  virtual float phase_inc() const = 0;
53  virtual void set_freq(float s) = 0;
54  };
55 
56  } // namespace blocksat
57 } // namespace gr
58 
59 #endif /* INCLUDED_BLOCKSAT_NCO_CC_H */
&lt;+description of block+&gt;
Definition: nco_cc.h:36
boost::shared_ptr< nco_cc > sptr
Definition: nco_cc.h:39
#define BLOCKSAT_API
Definition: api.h:30