GNU Radio 3.4.2 C++ API
gr_correlate_access_code_tag_bb Class Reference

Examine input for specified access code, one bit at a time.input: stream of bits, 1 bit per input byte (data in LSB) output: unaltered stream of bits (plus tags) More...

#include <gr_correlate_access_code_tag_bb.h>

Inheritance diagram for gr_correlate_access_code_tag_bb:

List of all members.

Public Member Functions

 ~gr_correlate_access_code_tag_bb ()
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
bool set_access_code (const std::string &access_code)

Protected Member Functions

 gr_correlate_access_code_tag_bb (const std::string &access_code, int threshold, const std::string &tag_name)

Friends

gr_correlate_access_code_tag_bb_sptr gr_make_correlate_access_code_tag_bb (const std::string &access_code, int threshold, const std::string &tag_name)

Detailed Description

Examine input for specified access code, one bit at a time.

input: stream of bits, 1 bit per input byte (data in LSB) output: unaltered stream of bits (plus tags)

This block annotates the input stream with tags. The tags have key name [tag_name], specified in the constructor. Used for searching an input data stream for preambles, etc.


Constructor & Destructor Documentation

gr_correlate_access_code_tag_bb::gr_correlate_access_code_tag_bb ( const std::string &  access_code,
int  threshold,
const std::string &  tag_name 
) [protected]
gr_correlate_access_code_tag_bb::~gr_correlate_access_code_tag_bb ( )

Member Function Documentation

bool gr_correlate_access_code_tag_bb::set_access_code ( const std::string &  access_code)
Parameters:
access_codeis represented with 1 byte per bit, e.g., "010101010111000100"
int gr_correlate_access_code_tag_bb::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_correlate_access_code_tag_bb_sptr gr_make_correlate_access_code_tag_bb ( const std::string &  access_code,
int  threshold,
const std::string &  tag_name 
) [friend]
Parameters:
access_codeis represented with 1 byte per bit, e.g., "010101010111000100"
thresholdmaximum number of bits that may be wrong
tag_namekey of the tag inserted into the tag stream

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