GNU Radio 3.6.5 C++ API

rms_cf.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005,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 #ifndef INCLUDED_BLOCKS_RMS_CF_H
00024 #define INCLUDED_BLOCKS_RMS_CF_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief RMS average power
00034      * \ingroup math_operators_blk
00035      */
00036     class BLOCKS_API rms_cf : virtual public gr_sync_block
00037     {
00038     public:
00039       // gr::blocks::rms_cf::sptr
00040       typedef boost::shared_ptr<rms_cf> sptr;
00041 
00042       /*!
00043        * \brief Make an RMS calc. block.
00044        * \param alpha gain for running average filter.
00045        */
00046       static sptr make(double alpha = 0.0001);
00047 
00048       virtual void set_alpha(double alpha) = 0;
00049     };
00050 
00051   } /* namespace blocks */
00052 } /* namespace gr */
00053 
00054 #endif /* INCLUDED_BLOCKS_RMS_CF_H */