GNU Radio v3.6.2-149-ga6d285d9 C++ API
gr_tag_debug.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2012 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_TAG_DEBUG_H
00024 #define INCLUDED_GR_TAG_DEBUG_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_sync_block.h>
00028 #include <gruel/thread.h>
00029 #include <stddef.h>
00030 
00031 class gr_tag_debug;
00032 typedef boost::shared_ptr<gr_tag_debug> gr_tag_debug_sptr;
00033 
00034 GR_CORE_API gr_tag_debug_sptr
00035 gr_make_tag_debug(size_t sizeof_stream_item, const std::string &name);
00036 
00037 /*!
00038  * \brief Bit bucket that prints out any tag received.
00039  * \ingroup sink_blk
00040  *
00041  * This block collects all tags sent to it on all input ports and
00042  * displays them to stdout in a formatted way. The \p name parameter
00043  * is used to identify which debug sink generated the tag, so when
00044  * connecting a block to this debug sink, an appropriate name is
00045  * something that identifies the input block.
00046  *
00047  * This block otherwise acts as a NULL sink in that items from the
00048  * input stream are ignored. It is designed to be able to attach to
00049  * any block and watch all tags streaming out of that block for
00050  * debugging purposes.
00051  *
00052  * The tags from the last call to this work function are stored and
00053  * can be retrieved using the function 'current_tags'.
00054  */
00055 class GR_CORE_API gr_tag_debug : public gr_sync_block
00056 {
00057  private:
00058   friend GR_CORE_API gr_tag_debug_sptr
00059     gr_make_tag_debug(size_t sizeof_stream_item, const std::string &name);
00060   gr_tag_debug(size_t sizeof_stream_item, const std::string &name);
00061 
00062   std::string d_name;
00063   std::vector<gr_tag_t> d_tags;
00064   std::vector<gr_tag_t>::iterator d_tags_itr;
00065   bool d_display;
00066   gruel::mutex d_mutex;
00067 
00068  public:
00069   /*!
00070    * \brief Returns a vector of gr_tag_t items as of the last call to
00071    * work.
00072    */
00073   std::vector<gr_tag_t> current_tags();
00074 
00075   /*!
00076    * \brief Set the display of tags to stdout on/off.
00077    */
00078   void set_display(bool d);
00079 
00080   int work(int noutput_items,
00081            gr_vector_const_void_star &input_items,
00082            gr_vector_void_star &output_items);
00083 };
00084 
00085 #endif /* INCLUDED_GR_TAG_DEBUG_H */