GNU Radio Manual and C++ API Reference  3.8.1.0
The Free & Open Software Radio Ecosystem
correlate_access_code_tag_ff.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005,2006,2011,2012,2017 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_TAG_FF_H
24 #define INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_TAG_FF_H
25 
26 #include <gnuradio/digital/api.h>
27 #include <gnuradio/sync_block.h>
28 #include <string>
29 
30 namespace gr {
31 namespace digital {
32 
33 /*!
34  * \brief Examine input for specified access code, one bit at a time.
35  * \ingroup packet_operators_blk
36  *
37  * \details
38  * input: stream of floats (generally, soft decisions)
39  * output: unaltered stream of bits (plus tags)
40  *
41  * This block annotates the input stream with tags. The tags have
42  * key name [tag_name], specified in the constructor. Used for
43  * searching an input data stream for preambles, etc., by slicing
44  * the soft decision symbol inputs.
45  */
47 {
48 public:
49  // gr::digital::correlate_access_code_tag_ff::sptr
50  typedef boost::shared_ptr<correlate_access_code_tag_ff> sptr;
51 
52  /*!
53  * \param access_code is represented with 1 byte per bit,
54  * e.g., "010101010111000100"
55  * \param threshold maximum number of bits that may be wrong
56  * \param tag_name key of the tag inserted into the tag stream
57  */
58  static sptr
59  make(const std::string& access_code, int threshold, const std::string& tag_name);
60 
61  /*!
62  * \param access_code is represented with 1 byte per bit,
63  * e.g., "010101010111000100"
64  */
65  virtual bool set_access_code(const std::string& access_code) = 0;
66  virtual void set_threshold(int threshold) = 0;
67  virtual void set_tagname(const std::string& tagname) = 0;
68 };
69 
70 } /* namespace digital */
71 } /* namespace gr */
72 
73 #endif /* INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_TAG_FF_H */
Examine input for specified access code, one bit at a time.
Definition: correlate_access_code_tag_ff.h:46
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
boost::shared_ptr< correlate_access_code_tag_ff > sptr
Definition: correlate_access_code_tag_ff.h:50
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition: basic_block.h:43
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37