Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / runtime / gr_io_signature.h
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 #ifndef INCLUDED_IO_SIGNATURE_H
24 #define INCLUDED_IO_SIGNATURE_H
25
26 #include <gr_runtime.h>
27
28 /*!
29  * \brief i/o signature for input and output ports.
30  *
31  * For now, we restrict all streams to be the same type.
32  * We can fix this later.
33  */
34   
35 class gr_io_signature {
36  public:
37
38   static const int IO_INFINITE = -1;
39     
40   ~gr_io_signature ();
41     
42   int min_streams () const { return d_min_streams; }
43   int max_streams () const { return d_max_streams; }
44   size_t sizeof_stream_item (int index) const { return d_sizeof_stream_item; }
45
46   // ----------------------------------------------------------------------------
47
48  private:
49   
50   int           d_min_streams;
51   int           d_max_streams;
52   size_t        d_sizeof_stream_item;
53
54   gr_io_signature (int min_streams, int max_streams, size_t sizeof_stream_item);
55
56   friend gr_io_signature_sptr gr_make_io_signature (int min_streams,
57                                                    int max_streams,
58                                                    size_t sizeof_stream_item);
59 };
60
61 gr_io_signature_sptr
62 gr_make_io_signature (int min_streams, int max_streams, size_t sizeof_stream_item);
63
64
65 #endif /* INCLUDED_IO_SIGNATURE_H */