GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
rail_ff.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2012 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_ANALOG_RAIL_FF_H
24#define INCLUDED_ANALOG_RAIL_FF_H
25
26#include <gnuradio/analog/api.h>
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30namespace analog {
31
32/*!
33 * \brief clips input values to min, max
34 * \ingroup level_controllers_blk
35 */
36class ANALOG_API rail_ff : virtual public sync_block
37{
38public:
39 // gr::analog::rail_ff::sptr
40 typedef boost::shared_ptr<rail_ff> sptr;
41
42 /*!
43 * Build a rail block.
44 *
45 * \param lo the low value to clip to.
46 * \param hi the high value to clip to.
47 */
48 static sptr make(float lo, float hi);
49
50 virtual float lo() const = 0;
51 virtual float hi() const = 0;
52
53 virtual void set_lo(float lo) = 0;
54 virtual void set_hi(float hi) = 0;
55};
56
57} /* namespace analog */
58} /* namespace gr */
59
60#endif /* INCLUDED_ANALOG_RAIL_FF_H */
clips input values to min, max
Definition: rail_ff.h:37
virtual void set_hi(float hi)=0
boost::shared_ptr< rail_ff > sptr
Definition: rail_ff.h:40
static sptr make(float lo, float hi)
virtual float hi() const =0
virtual float lo() const =0
virtual void set_lo(float lo)=0
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45