gr::blocks::tag_debug Class Reference
Bit bucket that prints out any tag received. More...
#include <tag_debug.h>
Public Types | |
| typedef boost::shared_ptr < tag_debug > | sptr |
Public Member Functions | |
| virtual std::vector< gr_tag_t > | current_tags ()=0 |
| Returns a vector of gr_tag_t items as of the last call to work. | |
| virtual void | set_display (bool d)=0 |
| Set the display of tags to stdout on/off. | |
Static Public Member Functions | |
| static sptr | make (size_t sizeof_stream_item, const std::string &name) |
Detailed Description
Bit bucket that prints out any tag received.
This block collects all tags sent to it on all input ports and displays them to stdout in a formatted way. The 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.
The tags from the last call to this work function are stored and can be retrieved using the function 'current_tags'.
Member Typedef Documentation
Member Function Documentation
| virtual std::vector<gr_tag_t> gr::blocks::tag_debug::current_tags | ( | ) | [pure virtual] |
Returns a vector of gr_tag_t items as of the last call to work.
Implemented in gr::blocks::tag_debug_impl.
| static sptr gr::blocks::tag_debug::make | ( | size_t | sizeof_stream_item, |
| const std::string & | name | ||
| ) | [static] |
Build a tag debug block
- Parameters:
-
sizeof_stream_item size of the items in the incoming stream. name name to identify which debug sink generated the info.
| virtual void gr::blocks::tag_debug::set_display | ( | bool | d | ) | [pure virtual] |
Set the display of tags to stdout on/off.
Implemented in gr::blocks::tag_debug_impl.
The documentation for this class was generated from the following file:
