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

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2006 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 along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21 class gr_file_sink_base
  22 {
  23  protected:
  24   gr_file_sink_base(const char *filename, bool is_binary);
  25
  26  public:
  27   ~gr_file_sink_base();
  28
  29   /*!
  30    * \brief Open filename and begin output to it.
  31    */
  32   bool open(const char *filename);
  33
  34   /*!
  35    * \brief Close current output file.
  36    *
  37    * Closes current output file and ignores any output until
  38    * open is called to connect to another file.
  39    */
  40   void close();
  41
  42   /*!
  43    * \brief if we've had an update, do it now.
  44    */
  45   void do_update();
  46 };