GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
threshold_ff.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,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_THRESHOLD_FF_H
24#define INCLUDED_GR_THRESHOLD_FF_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30namespace blocks {
31
32/*!
33 * \brief Output a 1 or zero based on a threshold value.
34 * \ingroup level_controllers_blk
35 *
36 * \details
37 * Test the incoming signal against a threshold. If the signal
38 * excedes the \p hi value, it will output a 1 until the signal
39 * falls below the \p lo value.
40 */
41class BLOCKS_API threshold_ff : virtual public sync_block
42{
43public:
44 // gr::blocks::threshold_ff::sptr
45 typedef boost::shared_ptr<threshold_ff> sptr;
46
47 /* \brief Create a threadshold block.
48 * \param lo Threshold input signal needs to drop below to
49 * change state to 0.
50 * \param hi Threshold input signal needs to rise above to
51 * change state to 1.
52 * \param initial_state Initial state of the block (0 or 1).
53 */
54 static sptr make(float lo, float hi, float initial_state = 0);
55
56 virtual float lo() const = 0;
57 virtual void set_lo(float lo) = 0;
58 virtual float hi() const = 0;
59 virtual void set_hi(float hi) = 0;
60 virtual float last_state() const = 0;
61 virtual void set_last_state(float last_state) = 0;
62};
63
64} /* namespace blocks */
65} /* namespace gr */
66
67#endif /* INCLUDED_GR_THRESHOLD_FF_H */
Output a 1 or zero based on a threshold value.
Definition: threshold_ff.h:42
virtual void set_last_state(float last_state)=0
virtual float hi() const =0
virtual float lo() const =0
static sptr make(float lo, float hi, float initial_state=0)
virtual float last_state() const =0
virtual void set_lo(float lo)=0
boost::shared_ptr< threshold_ff > sptr
Definition: threshold_ff.h:45
virtual void set_hi(float hi)=0
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
Include this header to use the message passing features.
Definition: basic_block.h:45