Statistics
| Branch: | Tag: | Revision:

root / gnuradio-core / src / lib / general / gr_correlate_access_code_tag_bb.i @ 7fce7e3b

History | View | Annotate | Download (2.3 kB)

1
/* -*- c++ -*- */
2
/*
3
 * Copyright 2006 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
GR_SWIG_BLOCK_MAGIC(gr,correlate_access_code_tag_bb);
24
25
/*!
26
 * \param access_code is represented with 1 byte per bit, e.g., "010101010111000100"
27
 * \param threshold maximum number of bits that may be wrong
28
 */
29
gr_correlate_access_code_tag_bb_sptr 
30
gr_make_correlate_access_code_tag_bb (const std::string &access_code, int threshold, const std::string &tag_name) 
31
  throw(std::out_of_range);
32
33
/*!
34
 * \brief Examine input for specified access code, one bit at a time.
35
 * \ingroup block
36
 *
37
 * input:  stream of bits, 1 bit per input byte (data in LSB)
38
 * output: stream of bits, 2 bits per output byte (data in LSB, flag in next higher bit)
39
 *
40
 * Each output byte contains two valid bits, the data bit, and the
41
 * flag bit.  The LSB (bit 0) is the data bit, and is the original
42
 * input data, delayed 64 bits.  Bit 1 is the
43
 * flag bit and is 1 if the corresponding data bit is the first data
44
 * bit following the access code. Otherwise the flag bit is 0.
45
 */
46
class gr_correlate_access_code_tag_bb : public gr_sync_block
47
{
48
  friend gr_correlate_access_code_tag_bb_sptr 
49
  gr_make_correlate_access_code_tag_bb (const std::string &access_code, int threshold, const std::string &tag_name);
50
 protected:
51
  gr_correlate_access_code_tag_bb(const std::string &access_code, int threshold, const std::string &tag_name);
52
53
 public:
54
  ~gr_correlate_access_code_tag_bb();
55
56
  /*!
57
   * \param access_code is represented with 1 byte per bit, e.g., "010101010111000100"
58
   */
59
  bool set_access_code (const std::string &access_code);
60
};