git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/io/gr_file_sink_base.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2004,2007 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_GR_FILE_SINK_BASE_H
  24 #define INCLUDED_GR_FILE_SINK_BASE_H
  25
  26 #include <gnuradio/omnithread.h>
  27 #include <cstdio>
  28
  29 /*!
  30  * \brief Common base class for file sinks
  31  */
  32 class gr_file_sink_base
  33 {
  34  protected:
  35   FILE         *d_fp;           // current FILE pointer
  36   FILE         *d_new_fp;       // new FILE pointer
  37   bool          d_updated;      // is there a new FILE pointer?
  38   bool          d_is_binary;
  39   omni_mutex    d_mutex;
  40
  41  protected:
  42   gr_file_sink_base(const char *filename, bool is_binary);
  43
  44  public:
  45   ~gr_file_sink_base();
  46
  47   /*!
  48    * \brief Open filename and begin output to it.
  49    */
  50   bool open(const char *filename);
  51
  52   /*!
  53    * \brief Close current output file.
  54    *
  55    * Closes current output file and ignores any output until
  56    * open is called to connect to another file.
  57    */
  58   void close();
  59
  60   /*!
  61    * \brief if we've had an update, do it now.
  62    */
  63   void do_update();
  64 };
  65
  66
  67 #endif /* INCLUDED_GR_FILE_SINK_BASE_H */