Updated license from GPL version 2 or later to GPL version 3 or later.
[debian/gnuradio] / gnuradio-core / src / lib / runtime / gr_hier_block2.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 #ifndef INCLUDED_GR_HIER_BLOCK2_H
23 #define INCLUDED_GR_HIER_BLOCK2_H
24
25 #include <gr_basic_block.h>
26
27 /*!
28  * \brief public constructor for gr_hier_block2
29  */
30 gr_hier_block2_sptr gr_make_hier_block2(const std::string &name,
31                                         gr_io_signature_sptr input_signature,
32                                         gr_io_signature_sptr output_signature);
33
34 class gr_hier_block2_detail;
35
36 /*!
37  * \brief gr_hier_block2 - Hierarchical container class for gr_block's
38  *
39  */
40 class gr_hier_block2 : public gr_basic_block
41 {
42 private:
43     friend class gr_hier_block2_detail;
44     friend class gr_runtime_impl;
45     friend gr_hier_block2_sptr gr_make_hier_block2(const std::string &name,
46                                                    gr_io_signature_sptr input_signature,
47                                                    gr_io_signature_sptr output_signature);
48
49     /*!
50      * \brief Private implementation details of gr_hier_block2
51      */
52     gr_hier_block2_detail *d_detail;
53
54     /* Internal use only */
55     void set_runtime(gr_runtime *runtime);
56
57 protected: 
58     gr_hier_block2(const std::string &name,
59                    gr_io_signature_sptr input_signature,
60                    gr_io_signature_sptr output_signature);
61
62 public:
63     virtual ~gr_hier_block2();
64
65     void connect(gr_basic_block_sptr src, int src_port, 
66                  gr_basic_block_sptr dst, int dst_port);
67     void disconnect(gr_basic_block_sptr src, int src_port,
68                     gr_basic_block_sptr dst, int dst_port);
69     void lock();
70     void unlock();
71 };
72
73 #endif /* INCLUDED_GR_HIER_BLOCK2_H */