Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_delay.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007 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_DELAY_H
24 #define INCLUDED_GR_DELAY_H
25
26 #include <gr_sync_block.h>
27
28 class gr_delay;
29 typedef boost::shared_ptr<gr_delay> gr_delay_sptr;
30
31 gr_delay_sptr gr_make_delay (size_t itemsize, int delay);
32
33 /*!
34  * \brief delay the input by a certain number of samples
35  * \ingroup misc_blk
36  */
37 class gr_delay : public gr_sync_block
38 {
39   friend gr_delay_sptr gr_make_delay (size_t itemsize, int delay);
40
41   gr_delay (size_t itemsize, int delay);
42
43   size_t d_itemsize;
44
45  public:
46   int delay () const { return history()-1; }
47   void set_delay (int delay) { set_history(delay+1); }
48
49   int work (int noutput_items,
50             gr_vector_const_void_star &input_items,
51             gr_vector_void_star &output_items);
52 };
53
54 #endif