GNU Radio 3.6.5 C++ API

null_sink.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2010,2013 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_NULL_SINK_H
00024 #define INCLUDED_GR_NULL_SINK_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_sync_block.h>
00028 #include <stddef.h>                     // size_t
00029 
00030 namespace gr {
00031   namespace blocks {
00032 
00033     /*!
00034      * \brief Bit bucket. Use as a termination point when a sink is
00035      * required and we don't want to do anything real.
00036      * \ingroup misc_blk
00037      */
00038     class BLOCKS_API null_sink : virtual public gr_sync_block
00039     {
00040     public:
00041       // gr::blocks::null_sink::sptr
00042       typedef boost::shared_ptr<null_sink> sptr;
00043 
00044       /*!
00045        * Build a null sink block.
00046        *
00047        * \param sizeof_stream_item size of the stream items in bytes.
00048        */
00049       static sptr make(size_t sizeof_stream_item);
00050     };
00051 
00052   } /* namespace blocks */
00053 } /* namespace gr */
00054 
00055 #endif /* INCLUDED_GR_NULL_SINK_H */