GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
file_sink.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,2007,2013 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_H
24 #define INCLUDED_GR_FILE_SINK_H
25 
26 #include <gnuradio/blocks/api.h>
28 #include <gnuradio/sync_block.h>
29 
30 namespace gr {
31  namespace blocks {
32 
33  /*!
34  * \brief Write stream to file.
35  * \ingroup file_operators_blk
36  */
37  class BLOCKS_API file_sink : virtual public sync_block,
38  virtual public file_sink_base
39  {
40  public:
41  // gr::blocks::file_sink::sptr
42  typedef boost::shared_ptr<file_sink> sptr;
43 
44  /*!
45  * \brief Make a file sink.
46  * \param itemsize size of the input data items.
47  * \param filename name of the file to open and write output to.
48  * \param append if true, data is appended to the file instead of
49  * overwriting the initial content.
50  */
51  static sptr make(size_t itemsize, const char *filename, bool append=false);
52  };
53 
54  } /* namespace blocks */
55 } /* namespace gr */
56 
57 #endif /* INCLUDED_GR_FILE_SINK_H */
Common base class for file sinks.
Definition: file_sink_base.h:36
boost::shared_ptr< file_sink > sptr
Definition: file_sink.h:42
Include this header to use the message passing features.
Definition: logger.h:131
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
Write stream to file.
Definition: file_sink.h:37
BLOCKS_API size_t itemsize(vector_type type)