GNU Radio 3.6.5 C++ API

delay.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2007,2012-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_BLOCKS_DELAY_H
00024 #define INCLUDED_BLOCKS_DELAY_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief delay the input by a certain number of samples
00034      * \ingroup misc_blk
00035      */
00036     class BLOCKS_API delay : virtual public gr_block
00037     {
00038     public:
00039       // gr::blocks::delay::sptr
00040       typedef boost::shared_ptr<delay> sptr;
00041 
00042       /*!
00043        * \brief Make a delay block.
00044        * \param itemsize size of the data items.
00045        * \param delay number of samples to delay stream.
00046        */
00047       static sptr make(size_t itemsize, int delay);
00048 
00049       virtual int dly() const = 0;
00050       virtual void set_dly(int d) = 0;
00051     };
00052 
00053   } /* namespace blocks */
00054 } /* namespace gr */
00055 
00056 #endif /* INCLUDED_BLOCKS_DELAY_H */
00057