Merged r4518:5130 from developer branch n4hy/ofdm into trunk, passes distcheck.
[debian/gnuradio] / gnuradio-core / src / lib / io / gr_message_vector_source.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 2, 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_MESSAGE_VECTOR_SOURCE_H
24 #define INCLUDED_GR_MESSAGE_VECTOR_SOURCE_H
25
26 #include <gr_sync_block.h>
27 #include <gr_message.h>
28 #include <gr_msg_queue.h>
29 #include <gr_frame.h>
30
31 class gr_message_vector_source;
32 typedef boost::shared_ptr<gr_message_vector_source> gr_message_vector_source_sptr;
33
34 gr_message_vector_source_sptr gr_make_message_vector_source (size_t max_msg_size, int msgq_limit=0);
35
36 /*!
37  * \brief Turn received messages into vectors
38  * \ingroup source
39  */
40 class gr_message_vector_source : public gr_sync_block
41 {
42  private:
43   size_t                d_max_msg_size;
44   gr_msg_queue_sptr     d_msgq;
45   bool                  d_eof;
46
47   friend gr_message_vector_source_sptr
48   gr_make_message_vector_source(size_t max_msg_size, int msgq_limit);
49
50  protected:
51   gr_message_vector_source (size_t max_msg_size, int msgq_limit);
52
53  public:
54   ~gr_message_vector_source ();
55
56   gr_msg_queue_sptr     msgq() const { return d_msgq; }
57
58   int work (int noutput_items,
59             gr_vector_const_void_star &input_items,
60             gr_vector_void_star &output_items);
61 };
62
63 #endif /* INCLUDED_GR_MESSAGE_VECTOR_SOURCE_H */