GNU Radio 3.7.1-34 C++ API
throttle.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2005-2011,2013 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
23
#ifndef INCLUDED_GR_THROTTLE_H
24
#define INCLUDED_GR_THROTTLE_H
25
26
#include <
gnuradio/blocks/api.h
>
27
#include <
gnuradio/sync_block.h
>
28
29
namespace
gr {
30
namespace
blocks {
31
32
/*!
33
* \brief throttle flow of samples such that the average rate does
34
* not exceed samples_per_sec.
35
* \ingroup misc_blk
36
*
37
* \details
38
* input: one stream of itemsize; output: one stream of itemsize
39
*
40
* N.B. this should only be used in GUI apps where there is no
41
* other rate limiting block. It is not intended nor effective at
42
* precisely controlling the rate of samples. That should be
43
* controlled by a source or sink tied to sample clock. E.g., a
44
* USRP or audio card.
45
*/
46
class
BLOCKS_API
throttle
:
virtual
public
sync_block
47
{
48
public
:
49
typedef
boost::shared_ptr<throttle>
sptr
;
50
51
static
sptr
make(
size_t
itemsize
,
double
samples_per_sec);
52
53
//! Sets the sample rate in samples per second.
54
virtual
void
set_sample_rate(
double
rate) = 0;
55
56
//! Get the sample rate in samples per second.
57
virtual
double
sample_rate()
const
= 0;
58
};
59
60
}
/* namespace blocks */
61
}
/* namespace gr */
62
63
#endif
/* INCLUDED_GR_THROTTLE_H */
gnuradio
gr-blocks
include
gnuradio
blocks
throttle.h
Generated by
1.8.1.1