GNU Radio 3.7.1 C++ API
file_sink.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2007,2013 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_GR_FILE_SINK_H
00024 #define INCLUDED_GR_FILE_SINK_H
00025 
00026 #include <gnuradio/blocks/api.h>
00027 #include <gnuradio/blocks/file_sink_base.h>
00028 #include <gnuradio/sync_block.h>
00029 
00030 namespace gr {
00031   namespace blocks {
00032 
00033     /*!
00034      * \brief Write stream to file.
00035      * \ingroup file_operators_blk
00036      */
00037     class BLOCKS_API file_sink : virtual public sync_block,
00038                                  virtual public file_sink_base
00039     {
00040     public:
00041       // gr::blocks::file_sink::sptr
00042       typedef boost::shared_ptr<file_sink> sptr;
00043 
00044       /*!
00045        * \brief Make a file sink.
00046        * \param itemsize size of the input data items.
00047        * \param filename name of the file to open and write output to.
00048        */
00049       static sptr make(size_t itemsize, const char *filename);
00050     };
00051 
00052   } /* namespace blocks */
00053 } /* namespace gr */
00054 
00055 #endif /* INCLUDED_GR_FILE_SINK_H */