GNU Radio 3.6.5 C++ API

moving_average_ff.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2008,2013 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 // WARNING: this file is machine generated. Edits will be overwritten
00024 
00025 #ifndef INCLUDED_BLOCKS_MOVING_AVERAGE_FF_H
00026 #define INCLUDED_BLOCKS_MOVING_AVERAGE_FF_H
00027 
00028 #include <blocks/api.h>
00029 #include <gr_sync_block.h>
00030 
00031 namespace gr {
00032   namespace blocks {
00033 
00034     /*!
00035      * \brief output is the moving sum of the last N samples, scaled by the scale factor
00036      * \ingroup level_controllers_blk
00037      */
00038     class BLOCKS_API moving_average_ff : virtual public gr_sync_block
00039     {
00040     public: 
00041       // gr::blocks::moving_average_ff::sptr
00042       typedef boost::shared_ptr<moving_average_ff> sptr;
00043 
00044       /*!
00045        * Create a moving average block.
00046        *
00047        * \param length Number of samples to use in the average.
00048        * \param scale scale factor for the result.
00049        * \param max_iter limits how long we go without flushing the accumulator
00050        *        This is necessary to avoid numerical instability for float and complex.
00051        */
00052       static sptr make(int length, float scale,
00053                        int max_iter = 4096);
00054 
00055       /*!
00056        * Get the length used in the avaraging calculation.
00057        */
00058       virtual int length() const = 0;
00059 
00060       /*!
00061        * Get the scale factor being used.
00062        */
00063       virtual float scale() const = 0;
00064 
00065       /*!
00066        * Set both the length and the scale factor together.
00067        */
00068       virtual void set_length_and_scale(int length, float scale) = 0;
00069 
00070       /*!
00071        * Set the length.
00072        */
00073       virtual void set_length(int length) = 0;
00074 
00075       /*!
00076        * Set the scale factor.
00077        */
00078       virtual void set_scale(float scale) = 0;
00079     };
00080 
00081   } /* namespace blocks */
00082 } /* namespace gr */
00083 
00084 #endif /* INCLUDED_BLOCKS_MOVING_AVERAGE_FF_H */