GNU Radio 3.6.4.2 C++ API
threshold_ff.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2013 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_THRESHOLD_FF_H
00024 #define INCLUDED_GR_THRESHOLD_FF_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief Output a 1 or zero based on a threshold value.
00034      * \ingroup misc_blk
00035      *
00036      * Test the incoming signal against a threshold. If the signal
00037      * excedes the \p hi value, it will output a 1 until the signal
00038      * falls below the \p lo value.
00039      */
00040     class BLOCKS_API threshold_ff : virtual public gr_sync_block
00041     {
00042     public:
00043       // gr::blocks::threshold_ff::sptr
00044       typedef boost::shared_ptr<threshold_ff> sptr;
00045 
00046       /* \brief Create a threadshold block.
00047        * \param lo Threshold input signal needs to drop below to
00048        *           change state to 0.
00049        * \param hi Threshold input signal needs to rise above to
00050        *           change state to 1.
00051        * \param initial_state Initial state of the block (0 or 1).
00052        */
00053       static sptr make(float lo, float hi, float initial_state=0);
00054 
00055       virtual float lo () const = 0;
00056       virtual void set_lo (float lo) = 0;
00057       virtual float hi () const = 0;
00058       virtual void set_hi (float hi) = 0;
00059       virtual float last_state () const = 0;
00060       virtual void set_last_state (float last_state) = 0;
00061     };
00062 
00063   } /* namespace blocks */
00064 } /* namespace gr */
00065 
00066 #endif /* INCLUDED_GR_THRESHOLD_FF_H */