GNU Radio C++ API Reference: correlate_access_code_tag_bb.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
correlate_access_code_tag_bb.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2005,2006,2011,2012 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_TAG_BB_H
12#define INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_TAG_BB_H
13
14#include <gnuradio/digital/api.h>
15#include <gnuradio/sync_block.h>
16#include <string>
17
18namespace gr {
19namespace digital {
20
21/*!
22 * \brief Examine input for specified access code, one bit at a time.
23 * \ingroup packet_operators_blk
24 *
25 * \details
26 * input: stream of bits, 1 bit per input byte (data in LSB)
27 * output: unaltered stream of bits (plus tags)
28 *
29 * This block annotates the input stream with tags. The tags have
30 * key name [tag_name], specified in the constructor. Used for
31 * searching an input data stream for preambles, etc.
32 */
33 class DIGITAL_API correlate_access_code_tag_bb : virtual public sync_block
34{
35public:
36 // gr::digital::correlate_access_code_tag_bb::sptr
37 typedef std::shared_ptr<correlate_access_code_tag_bb> sptr;
38
39 /*!
40 * \param access_code is represented with 1 byte per bit,
41 * e.g., "010101010111000100"
42 * \param threshold maximum number of bits that may be wrong
43 * \param tag_name key of the tag inserted into the tag stream
44 */
45 static sptr
46 make(const std::string& access_code, int threshold, const std::string& tag_name);
47
48 /*!
49 * \param access_code is represented with 1 byte per bit,
50 * e.g., "010101010111000100"
51 */
52 virtual bool set_access_code(const std::string& access_code) = 0;
53 virtual void set_threshold(int threshold) = 0;
54 virtual void set_tagname(const std::string& tagname) = 0;
55};
56
57} /* namespace digital */
58} /* namespace gr */
59
60#endif /* INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_TAG_BB_H */
gr::digital::correlate_access_code_tag_bb
Examine input for specified access code, one bit at a time.
Definition correlate_access_code_tag_bb.h:34
gr::digital::correlate_access_code_tag_bb::set_tagname
virtual void set_tagname(const std::string &tagname)=0
gr::digital::correlate_access_code_tag_bb::set_access_code
virtual bool set_access_code(const std::string &access_code)=0
gr::digital::correlate_access_code_tag_bb::set_threshold
virtual void set_threshold(int threshold)=0
gr::digital::correlate_access_code_tag_bb::make
static sptr make(const std::string &access_code, int threshold, const std::string &tag_name)
gr::digital::correlate_access_code_tag_bb::sptr
std::shared_ptr< correlate_access_code_tag_bb > sptr
Definition correlate_access_code_tag_bb.h:37
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
DIGITAL_API
#define DIGITAL_API
Definition gr-digital/include/gnuradio/digital/api.h:18
gr::digital
Definition adaptive_algorithm.h:22
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h