GNU Radio 3.6.5 C++ API

gr_rms_cf.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005 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 #ifndef INCLUDED_GR_RMS_CF_H
00023 #define INCLUDED_GR_RMS_CF_H
00024 
00025 #include <gr_core_api.h>
00026 #include <gr_sync_block.h>
00027 #include <gr_single_pole_iir.h>
00028 
00029 class gr_rms_cf;
00030 typedef boost::shared_ptr<gr_rms_cf> gr_rms_cf_sptr;
00031 
00032 GR_CORE_API gr_rms_cf_sptr
00033 gr_make_rms_cf (double alpha = 0.0001);
00034 
00035 /*!
00036  * \brief RMS average power
00037  */
00038 class GR_CORE_API gr_rms_cf : public gr_sync_block
00039 {
00040   gr_single_pole_iir<double,double,double>      d_iir;
00041   bool                                          d_unmuted;
00042 
00043   friend GR_CORE_API gr_rms_cf_sptr
00044   gr_make_rms_cf (double alpha);
00045 
00046   gr_rms_cf (double alpha);
00047 
00048 public:
00049   ~gr_rms_cf ();
00050 
00051   int work (int noutput_items,
00052             gr_vector_const_void_star &input_items,
00053             gr_vector_void_star &output_items);
00054 
00055   bool unmuted () const { return d_unmuted; }
00056 
00057   void set_alpha (double alpha);
00058 };
00059 
00060 #endif /* INCLUDED_GR_RMS_CF_H */