GNU Radio 3.5.1 C++ API
gr_file_sink_base.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2007,2008 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_BASE_H
00024 #define INCLUDED_GR_FILE_SINK_BASE_H
00025 
00026 #include <gr_core_api.h>
00027 #include <boost/thread.hpp>
00028 #include <cstdio>
00029 
00030 /*!
00031  * \brief Common base class for file sinks
00032  */
00033 class GR_CORE_API gr_file_sink_base
00034 {
00035  protected:
00036   FILE         *d_fp;           // current FILE pointer
00037   FILE         *d_new_fp;       // new FILE pointer
00038   bool          d_updated;      // is there a new FILE pointer?
00039   bool          d_is_binary;
00040   boost::mutex  d_mutex;
00041   bool          d_unbuffered;
00042 
00043  protected:
00044   gr_file_sink_base(const char *filename, bool is_binary);
00045 
00046  public:
00047   ~gr_file_sink_base();
00048 
00049   /*! 
00050    * \brief Open filename and begin output to it.
00051    */
00052   bool open(const char *filename);
00053 
00054   /*!
00055    * \brief Close current output file.
00056    *
00057    * Closes current output file and ignores any output until
00058    * open is called to connect to another file.
00059    */
00060   void close();
00061 
00062   /*!
00063    * \brief if we've had an update, do it now.
00064    */
00065   void do_update();
00066   
00067   
00068   /*!
00069    * \brief turn on unbuffered writes for slower outputs
00070    */
00071   void set_unbuffered(bool unbuffered);
00072 };
00073 
00074 
00075 #endif /* INCLUDED_GR_FILE_SINK_BASE_H */