GNU Radio 3.6.5.1 C++ API
gr_throttle.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2005-2011 Free Software Foundation, Inc.
4
*
5
* This file is part of GNU Radio
6
*
7
* GNU Radio is free software; you can redistribute it and/or modify
8
* it under the terms of the GNU General Public License as published by
9
* the Free Software Foundation; either version 3, or (at your option)
10
* any later version.
11
*
12
* GNU Radio is distributed in the hope that it will be useful,
13
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
* GNU General Public License for more details.
16
*
17
* You should have received a copy of the GNU General Public License
18
* along with GNU Radio; see the file COPYING. If not, write to
19
* the Free Software Foundation, Inc., 51 Franklin Street,
20
* Boston, MA 02110-1301, USA.
21
*/
22
#ifndef INCLUDED_GR_THROTTLE_H
23
#define INCLUDED_GR_THROTTLE_H
24
25
#include <
gr_core_api.h
>
26
#include <
gr_sync_block.h
>
27
28
/*!
29
* \brief throttle flow of samples such that the average rate does not exceed samples_per_sec.
30
*
31
* input: one stream of itemsize; output: one stream of itemsize
32
*
33
* N.B. this should only be used in GUI apps where there is no other
34
* rate limiting block. It is not intended nor effective at precisely
35
* controlling the rate of samples. That should be controlled by a
36
* source or sink tied to sample clock. E.g., a USRP or audio card.
37
*/
38
class
GR_CORE_API
gr_throttle
:
virtual
public
gr_sync_block
39
{
40
public
:
41
typedef
boost::shared_ptr<gr_throttle>
sptr
;
42
43
//! Sets the sample rate in samples per second
44
virtual
void
set_sample_rate(
double
rate) = 0;
45
};
46
47
GR_CORE_API
gr_throttle::sptr
gr_make_throttle
(
size_t
itemsize
,
double
samples_per_sec);
48
49
#endif
/* INCLUDED_GR_THROTTLE_H */
gnuradio-core
src
lib
general
gr_throttle.h
Generated on Mon Aug 19 2013 15:37:31 for GNU Radio 3.6.5.1 C++ API by
1.8.1.2