GNU Radio 3.7.2 C++ API
moving_average_cc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2008,2013 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 // WARNING: this file is machine generated. Edits will be overwritten
24 
25 #ifndef INCLUDED_BLOCKS_MOVING_AVERAGE_CC_H
26 #define INCLUDED_BLOCKS_MOVING_AVERAGE_CC_H
27 
28 #include <gnuradio/blocks/api.h>
29 #include <gnuradio/sync_block.h>
30 
31 namespace gr {
32  namespace blocks {
33 
34  /*!
35  * \brief output is the moving sum of the last N samples, scaled by the scale factor
36  * \ingroup level_controllers_blk
37  */
38  class BLOCKS_API moving_average_cc : virtual public sync_block
39  {
40  public:
41  // gr::blocks::moving_average_cc::sptr
43 
44  /*!
45  * Create a moving average block.
46  *
47  * \param length Number of samples to use in the average.
48  * \param scale scale factor for the result.
49  * \param max_iter limits how long we go without flushing the accumulator
50  * This is necessary to avoid numerical instability for float and complex.
51  */
52  static sptr make(int length, gr_complex scale,
53  int max_iter = 4096);
54 
55  /*!
56  * Get the length used in the avaraging calculation.
57  */
58  virtual int length() const = 0;
59 
60  /*!
61  * Get the scale factor being used.
62  */
63  virtual gr_complex scale() const = 0;
64 
65  /*!
66  * Set both the length and the scale factor together.
67  */
68  virtual void set_length_and_scale(int length, gr_complex scale) = 0;
69 
70  /*!
71  * Set the length.
72  */
73  virtual void set_length(int length) = 0;
74 
75  /*!
76  * Set the scale factor.
77  */
78  virtual void set_scale(gr_complex scale) = 0;
79  };
80 
81  } /* namespace blocks */
82 } /* namespace gr */
83 
84 #endif /* INCLUDED_BLOCKS_MOVING_AVERAGE_CC_H */
output is the moving sum of the last N samples, scaled by the scale factor
Definition: moving_average_cc.h:38
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
std::complex< float > gr_complex
Definition: gr_complex.h:27
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
PMT_API size_t length(const pmt_t &v)
Return the number of elements in v.
boost::shared_ptr< moving_average_cc > sptr
Definition: moving_average_cc.h:42