GNU Radio 3.6.5 C++ API

gr_annotator_1to1 Class Reference

1-to-1 stream annotator testing block. FOR TESTING PURPOSES ONLY. More...

#include <gr_annotator_1to1.h>

Inheritance diagram for gr_annotator_1to1:
gr_sync_block gr_block gr_basic_block gr_msg_accepter gruel::msg_accepter

List of all members.

Public Member Functions

 ~gr_annotator_1to1 ()
int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 just like gr_block::general_work, only this arranges to call consume_each for you
std::vector< gr_tag_tdata () const

Protected Member Functions

 gr_annotator_1to1 (int when, size_t sizeof_stream_item)

Friends

GR_CORE_API gr_annotator_1to1_sptr gr_make_annotator_1to1 (int when, size_t sizeof_stream_item)

Detailed Description

1-to-1 stream annotator testing block. FOR TESTING PURPOSES ONLY.

This block creates tags to be sent downstream every 10,000 items it sees. The tags contain the name and ID of the instantiated block, use "seq" as a key, and have a counter that increments by 1 for every tag produced that is used as the tag's value. The tags are propagated using the 1-to-1 policy.

It also stores a copy of all tags it sees flow past it. These tags can be recalled externally with the data() member.

This block is only meant for testing and showing how to use the tags.


Constructor & Destructor Documentation

gr_annotator_1to1::~gr_annotator_1to1 ( )
gr_annotator_1to1::gr_annotator_1to1 ( int  when,
size_t  sizeof_stream_item 
) [protected]

Member Function Documentation

std::vector<gr_tag_t> gr_annotator_1to1::data ( ) const [inline]
int gr_annotator_1to1::work ( int  noutput_items,
gr_vector_const_void_star input_items,
gr_vector_void_star output_items 
) [virtual]

just like gr_block::general_work, only this arranges to call consume_each for you

The user must override work to define the signal processing code

Implements gr_sync_block.


Friends And Related Function Documentation

GR_CORE_API gr_annotator_1to1_sptr gr_make_annotator_1to1 ( int  when,
size_t  sizeof_stream_item 
) [friend]

The documentation for this class was generated from the following file: