Doc fixes from Firas.
[debian/gnuradio] / gnuradio-core / src / lib / runtime / gr_flat_flowgraph.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006,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_FLAT_FLOWGRAPH_H
24 #define INCLUDED_GR_FLAT_FLOWGRAPH_H
25
26 #include <gr_flowgraph.h>
27 #include <gr_block.h>
28
29 // 32Kbyte buffer size between blocks
30 #define GR_FIXED_BUFFER_SIZE (32*(1L<<10))
31
32 // Create a shared pointer to a heap allocated gr_flat_flowgraph
33 // (types defined in gr_runtime_types.h)
34 gr_flat_flowgraph_sptr gr_make_flat_flowgraph();
35
36 /*!
37  *\brief Class specializing gr_flat_flowgraph that has all nodes
38  * as gr_blocks, with no hierarchy
39  * \ingroup base
40  *
41  */
42 class gr_flat_flowgraph : public gr_flowgraph
43 {
44 public:
45   friend gr_flat_flowgraph_sptr gr_make_flat_flowgraph();
46
47   // Destruct an arbitrary gr_flat_flowgraph
48   ~gr_flat_flowgraph();
49
50   // Wire gr_blocks together in new flat_flowgraph
51   void setup_connections();
52
53   // Merge applicable connections from existing flat flowgraph
54   void merge_connections(gr_flat_flowgraph_sptr sfg);
55
56 private:
57   gr_flat_flowgraph();
58
59   static const unsigned int s_fixed_buffer_size = GR_FIXED_BUFFER_SIZE;
60   gr_block_detail_sptr allocate_block_detail(gr_basic_block_sptr block, 
61                                              gr_block_detail_sptr old_detail=gr_block_detail_sptr());
62   gr_buffer_sptr allocate_buffer(gr_basic_block_sptr block, int port);
63   void connect_block_inputs(gr_basic_block_sptr block);
64 };
65
66 #endif /* INCLUDED_GR_FLAT_FLOWGRAPH_H */