Fixed spelling error: s/writeable/writable/g
[debian/gnuradio] / gr-msdd6000 / src / lib / msdd_source_c.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2008 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_MSDD_SOURCE_C_H
24 #define INCLUDED_MSDD_SOURCE_C_H
25
26 #include <msdd_source_base.h>
27 #include <msdd_buffer_copy_behaviors.h>
28 #include <stdexcept>
29
30 class msdd_source_c;
31 typedef boost::shared_ptr<msdd_source_c> msdd_source_c_sptr;
32
33 // public shared_ptr constructor
34
35 msdd_source_c_sptr
36 msdd_make_source_c (int which_board, 
37                     int opp_mode,
38                     const char *src, 
39                     unsigned short port_src
40                     ) throw (std::runtime_error);
41
42 /*!
43  * \brief interface to MSDD Rx path
44  *
45  * output: 1 stream of short
46  */
47 class msdd_source_c : public msdd_source_base {
48 private:
49   friend msdd_source_c_sptr
50   msdd_make_source_c (int which_board, 
51                       int opp_mode,
52                       const char *src, 
53                       unsigned short port_src
54                       ) throw (std::runtime_error);
55
56   std::auto_ptr<msdd::BufferCopyBehavior> d_buffer_copy_behavior;
57
58 protected:
59   msdd_source_c (int which_board, 
60                  int opp_mode,
61                  const char *src, 
62                  unsigned short port_src
63                  ) throw (std::runtime_error);
64
65   int ninput_bytes_reqd_for_noutput_items (int noutput_items);
66
67   virtual void copy_from_msdd_buffer (gr_vector_void_star &output_items,
68                                       int output_index,
69                                       int output_items_available,
70                                       int &output_items_produced,
71                                       const void *msdd_buffer,
72                                       int buffer_length,
73                                       int &bytes_read);
74
75 public:
76   ~msdd_source_c ();
77 };
78
79 #endif /* INCLUDED_MSDD_SOURCE_C_H */