GNU Radio 3.6.5 C++ API

multiply_const_ff.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2012 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 // @WARNING@
00024 
00025 #ifndef INCLUDED_MULTIPLY_CONST_FF_H
00026 #define INCLUDED_MULTIPLY_CONST_FF_H
00027 
00028 #include <blocks/api.h>
00029 #include <gr_sync_block.h>
00030 
00031 namespace gr {
00032   namespace blocks {
00033 
00034     /*!
00035      * \brief output = input * real constant
00036      * \ingroup math_operators_blk
00037      */
00038     class BLOCKS_API multiply_const_ff : virtual public gr_sync_block
00039     {
00040 
00041     public:
00042       
00043       // gr::blocks::multiply_const_ff::sptr
00044       typedef boost::shared_ptr<multiply_const_ff> sptr;
00045       
00046       /*!
00047        * \brief Create an instance of multiply_const_ff
00048        * \param k real multiplicative constant
00049        * \param vlen Vector length of incoming stream
00050        */
00051       static sptr make(float k, size_t vlen=1);
00052       
00053       /*!
00054        * \brief Return real multiplicative constant
00055        */
00056       virtual float k() const = 0;
00057 
00058       /*!
00059        * \brief Set real multiplicative constant
00060        */
00061       virtual void set_k(float k) = 0;
00062     };
00063 
00064   } /* namespace blocks */
00065 } /* namespace gr */
00066 
00067 #endif /* INCLUDED_MULTIPLY_CONST_FF_H */