<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.3.0 C++ API: atsci_fs_checker.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<h1>atsci_fs_checker.h</h1><a href="atsci__fs__checker_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2002 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef _ATSC_FS_CHECKER_H_</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _ATSC_FS_CHECKER_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <<a class="code" href="atsci__syminfo_8h.html">atsci_syminfo.h</a>></span>
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment">/*!</span>
<a name="l00028"></a>00028 <span class="comment"> * \brief abstract base class for ATSC field sync checker</span>
<a name="l00029"></a>00029 <span class="comment"> *</span>
<a name="l00030"></a>00030 <span class="comment"> * Processes input samples one at a time looking for</span>
<a name="l00031"></a>00031 <span class="comment"> * an occurence of either the field sync 1 or field sync 2 pattern.</span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * Note that unlike atsci_fs_correlator, this class uses the symbol_num in </span>
<a name="l00034"></a>00034 <span class="comment"> * input_tag to avoid having to test each symbol position.</span>
<a name="l00035"></a>00035 <span class="comment"> *</span>
<a name="l00036"></a>00036 <span class="comment"> * For each sample processed, an output sample and an output tag are produced.</span>
<a name="l00037"></a>00037 <span class="comment"> * The output samples are identical to the input samples but are delayed by</span>
<a name="l00038"></a>00038 <span class="comment"> * a number of samples given by \p delay(). The output tag associated with</span>
<a name="l00039"></a>00039 <span class="comment"> * the the given output sample indicates whether this sample is the beginning</span>
<a name="l00040"></a>00040 <span class="comment"> * of one of the field syncs or is an ordinary sample. The tags are defined in</span>
<a name="l00041"></a>00041 <span class="comment"> * atsci_sync_tag.h.</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> * For ease of use, the field sync patterns are defined to begin with the</span>
<a name="l00044"></a>00044 <span class="comment"> * first symbol of the 4 symbol data segment sync pattern that immediately</span>
<a name="l00045"></a>00045 <span class="comment"> * proceeds the actual PN 511 code. This makes it easier for downstream code</span>
<a name="l00046"></a>00046 <span class="comment"> * to determine the location of data segment syncs merely by counting. They'll</span>
<a name="l00047"></a>00047 <span class="comment"> * occur every 832 samples assuming everything is working.</span>
<a name="l00048"></a>00048 <span class="comment"> */</span>
<a name="l00049"></a>00049
<a name="l00050"></a><a class="code" href="classatsci__fs__checker.html">00050</a> <span class="keyword">class </span><a class="code" href="classatsci__fs__checker.html" title="abstract base class for ATSC field sync checker">atsci_fs_checker</a> {
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">public</span>:
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="comment">// CREATORS</span>
<a name="l00055"></a>00055 <a class="code" href="classatsci__fs__checker.html#af6dc8b2ac60bfa16b7c0a76cf850d032">atsci_fs_checker</a> ();
<a name="l00056"></a>00056 <span class="keyword">virtual</span> <a class="code" href="classatsci__fs__checker.html#a61ce2227deb80a8d6921851171842c71">~atsci_fs_checker</a> () = 0;
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">// MANIPULATORS</span>
<a name="l00059"></a>00059 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classatsci__fs__checker.html#a288226c4f2a57a161e84bf4de935169e">reset</a> () = 0;
<a name="l00060"></a>00060 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classatsci__fs__checker.html#a6770714d6b09f8c4bb9facd51814e67c">filter</a> (<span class="keywordtype">float</span> input_sample, <a class="code" href="structatsc_1_1syminfo.html">atsc::syminfo</a> input_tag,
<a name="l00061"></a>00061 <span class="keywordtype">float</span> *output_sample, <a class="code" href="structatsc_1_1syminfo.html">atsc::syminfo</a> *output_tag) = 0;
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="comment">// ACCESSORS</span>
<a name="l00064"></a>00064 <span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> //! return delay in samples from input to output</span>
<a name="l00066"></a>00066 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classatsci__fs__checker.html#aa9acc7f6ad5fb19e8ffb599b9c959a34" title="return delay in samples from input to output">delay</a> () <span class="keyword">const</span> = 0;
<a name="l00067"></a>00067 };
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="preprocessor">#endif </span><span class="comment">/* _ATSC_FS_CHECKER_H_ */</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:50:59 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
