GNU Radio 3.7.2 C++ API
gr-comedi/include/gnuradio/comedi/sink_s.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005,2012 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_COMEDI_SINK_H
24 #define INCLUDED_COMEDI_SINK_H
25 
26 #include <gnuradio/comedi/api.h>
27 #include <gnuradio/sync_block.h>
28 
29 namespace gr {
30  namespace comedi {
31 
32  /*!
33  * \brief sink using COMEDI
34  *
35  * The sink has one input stream of signed short integers.
36  *
37  * Input samples must be in the range [-32768,32767].
38  */
39  class COMEDI_API sink_s : virtual public sync_block
40  {
41  public:
42  // gr::comedi::sink_s::sptr
44 
45  /*!
46  * \brief make a COMEDI sink.
47  *
48  * \param sampling_freq sampling rate in Hz
49  * \param dev COMEDI device name, e.g., "/dev/comedi0"
50  */
51  static sptr make(int sampling_freq,
52  const std::string dev = "/dev/comedi0");
53  };
54 
55  } /* namespace comedi */
56 } /* namespace gr */
57 
58 #endif /* INCLUDED_COMEDI_SINK_H */
#define COMEDI_API
Definition: gr-comedi/include/gnuradio/comedi/api.h:30
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
sink using COMEDI
Definition: gr-comedi/include/gnuradio/comedi/sink_s.h:39
boost::shared_ptr< sink_s > sptr
Definition: gr-comedi/include/gnuradio/comedi/sink_s.h:43
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37