GNU Radio C++ API Reference: correlate_access_code_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_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_BB_H
12#define INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_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 * \ingroup deprecated_blk
25 *
26 * \details
27 * input: stream of bits, 1 bit per input byte (data in LSB)
28 * output: stream of bits, 2 bits per output byte (data in LSB, flag in next higher bit)
29 *
30 * Each output byte contains two valid bits, the data bit, and the
31 * flag bit. The LSB (bit 0) is the data bit, and is the original
32 * input data, delayed 64 bits. Bit 1 is the flag bit and is 1 if
33 * the corresponding data bit is the first data bit following the
34 * access code. Otherwise the flag bit is 0.
35 */
36 class DIGITAL_API correlate_access_code_bb : virtual public sync_block
37{
38public:
39 // gr::digital::correlate_access_code_bb::sptr
40 typedef std::shared_ptr<correlate_access_code_bb> sptr;
41
42 /*!
43 * Make a correlate_access_code block.
44 *
45 * \param access_code is represented with 1 byte per bit,
46 * e.g., "010101010111000100"
47 * \param threshold maximum number of bits that may be wrong
48 */
49 static sptr make(const std::string& access_code, int threshold);
50
51 /*!
52 * Set a new access code.
53 *
54 * \param access_code is represented with 1 byte per bit,
55 * e.g., "010101010111000100"
56 */
57 virtual bool set_access_code(const std::string& access_code) = 0;
58};
59
60} /* namespace digital */
61} /* namespace gr */
62
63#endif /* INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_BB_H */
gr::digital::correlate_access_code_bb
Examine input for specified access code, one bit at a time.
Definition correlate_access_code_bb.h:37
gr::digital::correlate_access_code_bb::sptr
std::shared_ptr< correlate_access_code_bb > sptr
Definition correlate_access_code_bb.h:40
gr::digital::correlate_access_code_bb::make
static sptr make(const std::string &access_code, int threshold)
gr::digital::correlate_access_code_bb::set_access_code
virtual bool set_access_code(const std::string &access_code)=0
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