GNU Radio 3.5.1 C++ API
gr_throttle.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005-2011 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_THROTTLE_H
00023 #define INCLUDED_GR_THROTTLE_H
00024 
00025 #include <gr_core_api.h>
00026 #include <gr_sync_block.h>
00027 
00028 /*!
00029  * \brief throttle flow of samples such that the average rate does not exceed samples_per_sec.
00030  * \ingroup misc_blk
00031  *
00032  * input: one stream of itemsize; output: one stream of itemsize
00033  *
00034  * N.B. this should only be used in GUI apps where there is no other
00035  * rate limiting block.  It is not intended nor effective at precisely
00036  * controlling the rate of samples.  That should be controlled by a
00037  * source or sink tied to sample clock.  E.g., a USRP or audio card.
00038  */
00039 class GR_CORE_API gr_throttle : virtual public gr_sync_block
00040 {
00041 public:
00042     typedef boost::shared_ptr<gr_throttle> sptr;
00043 
00044     //! Sets the sample rate in samples per second
00045     virtual void set_sample_rate(double rate) = 0;
00046 };
00047 
00048 GR_CORE_API gr_throttle::sptr gr_make_throttle(size_t itemsize, double samples_per_sec);
00049 
00050 #endif /* INCLUDED_GR_THROTTLE_H */