Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / runtime / gr_block.i
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 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 class gr_block;
24 typedef boost::shared_ptr<gr_block> gr_block_sptr;
25 %template(gr_block_sptr) boost::shared_ptr<gr_block>;
26
27 // support vectors of these...
28 namespace std {
29   %template(x_vector_gr_block_sptr)     vector<gr_block_sptr>;
30 };
31
32 class gr_block {
33  protected:
34   gr_block (const std::string &name,
35              gr_io_signature_sptr input_signature,
36              gr_io_signature_sptr output_signature);
37
38  public:
39   
40   virtual ~gr_block ();
41   
42   std::string name () const;
43   gr_io_signature_sptr input_signature () const;
44   gr_io_signature_sptr output_signature () const;
45   long unique_id () const;
46   unsigned history () const;
47
48   int  output_multiple () const;
49   double relative_rate () const;
50
51   bool check_topology (int ninputs, int noutputs);
52   bool start();
53   bool stop();
54
55   // internal use
56   gr_block_detail_sptr detail () const { return d_detail; }
57   void set_detail (gr_block_detail_sptr detail) { d_detail = detail; }
58 };
59
60 %rename(block_ncurrently_allocated) gr_block_ncurrently_allocated;
61 long gr_block_ncurrently_allocated ();
62
63 %pythoncode %{
64 gr_block_sptr.__repr__ = lambda self: "<gr_block %s (%d)>" % (self.name(), self.unique_id ())
65 gr_block_sptr.block = lambda self: self
66 %}