GNU Radio 3.6.4 C++ API
gr_file_sink_base.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,2007,2008 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 <gr_core_api.h>
27 #include <boost/thread.hpp>
28 #include <cstdio>
29 
30 /*!
31  * \brief Common base class for file sinks
32  */
34 {
35  protected:
36  FILE *d_fp; // current FILE pointer
37  FILE *d_new_fp; // new FILE pointer
38  bool d_updated; // is there a new FILE pointer?
42 
43  protected:
44  gr_file_sink_base(const char *filename, bool is_binary);
45 
46  public:
48 
49  /*!
50  * \brief Open filename and begin output to it.
51  */
52  bool open(const char *filename);
53 
54  /*!
55  * \brief Close current output file.
56  *
57  * Closes current output file and ignores any output until
58  * open is called to connect to another file.
59  */
60  void close();
61 
62  /*!
63  * \brief if we've had an update, do it now.
64  */
65  void do_update();
66 
67 
68  /*!
69  * \brief turn on unbuffered writes for slower outputs
70  */
71  void set_unbuffered(bool unbuffered);
72 };
73 
74 
75 #endif /* INCLUDED_GR_FILE_SINK_BASE_H */