GNU Radio 3.7.1 C++ API
sink_s.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005,2012 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_COMEDI_SINK_H
00024 #define INCLUDED_COMEDI_SINK_H
00025 
00026 #include <gnuradio/comedi/api.h>
00027 #include <gnuradio/sync_block.h>
00028 
00029 namespace gr {
00030   namespace comedi {
00031     
00032     /*!
00033      * \brief sink using COMEDI
00034      *
00035      * The sink has one input stream of signed short integers.
00036      *
00037      * Input samples must be in the range [-32768,32767].
00038      */
00039     class COMEDI_API sink_s : virtual public sync_block
00040     {
00041     public:
00042       // gr::comedi::sink_s::sptr
00043       typedef boost::shared_ptr<sink_s> sptr;
00044 
00045       /*!
00046        * \brief make a COMEDI sink.
00047        *
00048        * \param sampling_freq sampling rate in Hz
00049        * \param dev COMEDI device name, e.g., "/dev/comedi0"
00050        */
00051       static sptr make(int sampling_freq,
00052                        const std::string dev = "/dev/comedi0");
00053     };
00054 
00055   } /* namespace comedi */
00056 } /* namespace gr */
00057 
00058 #endif /* INCLUDED_COMEDI_SINK_H */