GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
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
30namespace gr {
31namespace blocks {
32
33/*!
34 * \brief Write stream to file.
35 * \ingroup file_operators_blk
36 */
37class BLOCKS_API file_sink : virtual public sync_block, virtual public file_sink_base
38{
39public:
40 // gr::blocks::file_sink::sptr
41 typedef boost::shared_ptr<file_sink> sptr;
42
43 /*!
44 * \brief Make a file sink.
45 * \param itemsize size of the input data items.
46 * \param filename name of the file to open and write output to.
47 * \param append if true, data is appended to the file instead of
48 * overwriting the initial content.
49 */
50 static sptr make(size_t itemsize, const char* filename, bool append = false);
51};
52
53} /* namespace blocks */
54} /* namespace gr */
55
56#endif /* INCLUDED_GR_FILE_SINK_H */
Common base class for file sinks.
Definition: file_sink_base.h:37
Write stream to file.
Definition: file_sink.h:38
static sptr make(size_t itemsize, const char *filename, bool append=false)
Make a file sink.
boost::shared_ptr< file_sink > sptr
Definition: file_sink.h:41
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
BLOCKS_API size_t itemsize(vector_type type)
Include this header to use the message passing features.
Definition: basic_block.h:45