/* -*- c++ -*- */
/*
 * Copyright 2012-2013 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_GR_TAG_DEBUG_H
#define INCLUDED_GR_TAG_DEBUG_H

#include <gnuradio/blocks/api.h>
#include <gnuradio/sync_block.h>

namespace gr {
namespace blocks {

/*!
 * \brief Bit bucket that prints out any tag received.
 * \ingroup measurement_tools_blk
 * \ingroup stream_tag_tools_blk
 * \ingroup debug_tools_blk
 *
 * \details
 * This block collects all tags sent to it on all input ports and
 * displays them to stdout in a formatted way. The \p name
 * parameter is used to identify which debug sink generated the
 * tag, so when connecting a block to this debug sink, an
 * appropriate name is something that identifies the input block.
 *
 * This block otherwise acts as a NULL sink in that items from the
 * input stream are ignored. It is designed to be able to attach
 * to any block and watch all tags streaming out of that block for
 * debugging purposes.
 *
 * Specifying a key will allow this block to filter out all other
 * tags and only display tags that match the given key. This can
 * help clean up the output and allow you to focus in on a
 * particular tag of interest.
 *
 * The tags from the last call to this work function are stored
 * and can be retrieved using the function 'current_tags'.
 */
class BLOCKS_API tag_debug : virtual public sync_block
{
public:
    // gr::blocks::tag_debug::sptr
    typedef boost::shared_ptr<tag_debug> sptr;

    /*!
     * Build a tag debug block
     *
     * \param sizeof_stream_item size of the items in the incoming stream.
     * \param name name to identify which debug sink generated the info.
     * \param key_filter Specify a tag's key value to use as a filter.
     */
    static sptr make(size_t sizeof_stream_item,
                     const std::string& name,
                     const std::string& key_filter = "");

    /*!
     * \brief Returns a vector of tag_t items as of the last call to
     * work.
     */
    virtual std::vector<tag_t> current_tags() = 0;

    /*!
     * \brief Return the total number of tags in the tag queue.
     */
    virtual int num_tags() = 0;

    /*!
     * \brief Set the display of tags to stdout on/off.
     */
    virtual void set_display(bool d) = 0;

    /*!
     * \brief Set a new key to filter with.
     */
    virtual void set_key_filter(const std::string& key_filter) = 0;

    /*!
     * \brief Get the current filter key.
     */
    virtual std::string key_filter() const = 0;
};

} /* namespace blocks */
} /* namespace gr */

#endif /* INCLUDED_GR_TAG_DEBUG_H */
