GNU Radio 3.5.1 C++ API
gr_file_sink.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2007 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 <gr_core_api.h>
00027 #include <gr_sync_block.h>
00028 #include <gr_file_sink_base.h>
00029 
00030 class gr_file_sink;
00031 typedef boost::shared_ptr<gr_file_sink> gr_file_sink_sptr;
00032 
00033 GR_CORE_API gr_file_sink_sptr gr_make_file_sink(size_t itemsize, const char *filename);
00034 
00035 /*!
00036  * \brief Write stream to file.
00037  * \ingroup sink_blk
00038  */
00039 
00040 class GR_CORE_API gr_file_sink : public gr_sync_block, public gr_file_sink_base
00041 {
00042   friend GR_CORE_API gr_file_sink_sptr gr_make_file_sink(size_t itemsize, const char *filename);
00043 
00044  private:
00045   size_t        d_itemsize;
00046 
00047  protected:
00048   gr_file_sink(size_t itemsize, const char *filename);
00049 
00050  public:
00051   ~gr_file_sink();
00052 
00053   int work(int noutput_items,
00054            gr_vector_const_void_star &input_items,
00055            gr_vector_void_star &output_items);
00056 };
00057 
00058 #endif /* INCLUDED_GR_FILE_SINK_H */