GNU Radio C++ API Reference: correlate_access_code_ff_ts.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_ff_ts.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2014 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_FF_TS_H
12#define INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_FF_TS_H
13
14#include <gnuradio/block.h>
15#include <gnuradio/digital/api.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 floats (generally, soft decisions)
27 * output: a tagged stream set of samples from the payload following
28 * the access code and header.
29 *
30 * This block searches for the given access code by slicing the
31 * soft decision symbol inputs. Once found, it expects the
32 * following 32 samples to contain a header that includes the
33 * frame length (16 bits for the length, repeated). It decodes the
34 * header to get the frame length in order to set up the the
35 * tagged stream key information.
36 *
37 * The output of this block is appropriate for use with tagged
38 * stream blocks.
39 */
40 class DIGITAL_API correlate_access_code_ff_ts : virtual public block
41{
42public:
43 // gr::digital::correlate_access_code_ff_ts::sptr
44 typedef std::shared_ptr<correlate_access_code_ff_ts> sptr;
45
46 /*!
47 * \param access_code is represented with 1 byte per bit,
48 * e.g., "010101010111000100"
49 * \param threshold maximum number of bits that may be wrong
50 * \param tag_name key of the tag inserted into the tag stream
51 */
52 static sptr
53 make(const std::string& access_code, int threshold, const std::string& tag_name);
54
55 /*!
56 * \param access_code is represented with 1 byte per bit,
57 * e.g., "010101010111000100"
58 */
59 virtual bool set_access_code(const std::string& access_code) = 0;
60 virtual unsigned long long access_code() const = 0;
61};
62
63} /* namespace digital */
64} /* namespace gr */
65
66#endif /* INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_FF_TS_H */
gr::block::block
block(void)
Definition gnuradio-runtime/include/gnuradio/block.h:806
gr::digital::correlate_access_code_ff_ts
Examine input for specified access code, one bit at a time.
Definition correlate_access_code_ff_ts.h:41
gr::digital::correlate_access_code_ff_ts::make
static sptr make(const std::string &access_code, int threshold, const std::string &tag_name)
gr::digital::correlate_access_code_ff_ts::access_code
virtual unsigned long long access_code() const =0
gr::digital::correlate_access_code_ff_ts::sptr
std::shared_ptr< correlate_access_code_ff_ts > sptr
Definition correlate_access_code_ff_ts.h:44
gr::digital::correlate_access_code_ff_ts::set_access_code
virtual bool set_access_code(const std::string &access_code)=0
block.h
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