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