GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
probe_rate.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2005,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_BLOCKS_PROBE_RATE_H
24#define INCLUDED_BLOCKS_PROBE_RATE_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30namespace blocks {
31
32/*!
33 * \brief throughput measurement
34 * \ingroup measurement_tools_blk
35 */
36class BLOCKS_API probe_rate : virtual public sync_block
37{
38public:
39 // gr::blocks::probe_rate::sptr
40 typedef boost::shared_ptr<probe_rate> sptr;
41
42 /*!
43 * \brief Make a throughput measurement block
44 * \param itemsize size of each stream item
45 * \param update_rate_ms minimum update time in milliseconds
46 * \param alpha gain for running average filter
47 */
48 static sptr
49 make(size_t itemsize, double update_rate_ms = 500.0, double alpha = 0.0001);
50
51 virtual void set_alpha(double alpha) = 0;
52
53 virtual double rate() = 0;
54
55 virtual bool start() = 0;
56 virtual bool stop() = 0;
57};
58
59} /* namespace blocks */
60} /* namespace gr */
61
62#endif /* INCLUDED_BLOCKS_PROBE_RATE_H */
throughput measurement
Definition probe_rate.h:37
static sptr make(size_t itemsize, double update_rate_ms=500.0, double alpha=0.0001)
Make a throughput measurement block.
virtual double rate()=0
virtual bool stop()=0
Called to disable drivers, etc for i/o devices.
virtual void set_alpha(double alpha)=0
virtual bool start()=0
Called to enable drivers, etc for i/o devices.
boost::shared_ptr< probe_rate > sptr
Definition probe_rate.h:40
synchronous 1:1 input to output with history
Definition sync_block.h:38
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46