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