Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 7793

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.3">
  <compounddef id="classgr__simple__correlator" kind="class" prot="public">
    <compoundname>gr_simple_correlator</compoundname>
    <basecompoundref refid="classgr__block" prot="public" virt="non-virtual">gr_block</basecompoundref>
    <includes refid="gr__simple__correlator_8h" local="no">gr_simple_correlator.h</includes>
      <sectiondef kind="private-type">
      <memberdef kind="enum" id="classgr__simple__correlator_1ac429619a738ab152923e3e227742429e" prot="private" static="no">
        <name>state_t</name>
        <enumvalue id="classgr__simple__correlator_1ac429619a738ab152923e3e227742429ea5f2d9fc1082bea53f899fa375ba8343e" prot="private">
          <name>ST_LOOKING</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="classgr__simple__correlator_1ac429619a738ab152923e3e227742429ea3a2df3f371ccfbf5b4c82819a40ae385" prot="private">
          <name>ST_UNDER_THRESHOLD</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="classgr__simple__correlator_1ac429619a738ab152923e3e227742429ea8ebd4faa6f37ea94818796daf110d191" prot="private">
          <name>ST_LOCKED</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="43" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="43" bodyend="43"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-static-attrib">
      <memberdef kind="variable" id="classgr__simple__correlator_1a1ed450ed9035055006d0f76ecac2000b" prot="private" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int gr_simple_correlator::OVERSAMPLE</definition>
        <argsstring></argsstring>
        <name>OVERSAMPLE</name>
        <initializer> 8</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="42" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="42" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a6fc8a6ddfcb31c12bd853ed27ea55350" prot="private" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int gr_simple_correlator::AVG_PERIOD</definition>
        <argsstring></argsstring>
        <name>AVG_PERIOD</name>
        <initializer> 512</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="55" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="55" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classgr__simple__correlator_1a503ab3e3d4b6346bcd2288006770fe37" prot="private" static="no" mutable="no">
        <type>int</type>
        <definition>int gr_simple_correlator::d_payload_bytesize</definition>
        <argsstring></argsstring>
        <name>d_payload_bytesize</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="45" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="45" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a9ed943eceeb65f69e2f1ef27fdd9c291" prot="private" static="no" mutable="no">
        <type>state_t</type>
        <definition>state_t gr_simple_correlator::d_state</definition>
        <argsstring></argsstring>
        <name>d_state</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="46" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="46" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a6bfadb7cf32f3ad42151b1e4f26c1b71" prot="private" static="no" mutable="no">
        <type>unsigned int</type>
        <definition>unsigned int gr_simple_correlator::d_osi</definition>
        <argsstring></argsstring>
        <name>d_osi</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="47" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="47" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a1c92222004eb5d25b5bb87f6c7c7a39c" prot="private" static="no" mutable="no">
        <type>unsigned int</type>
        <definition>unsigned int gr_simple_correlator::d_transition_osi</definition>
        <argsstring></argsstring>
        <name>d_transition_osi</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="48" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="48" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a382fd1f915f08cf682c58af49935640e" prot="private" static="no" mutable="no">
        <type>unsigned int</type>
        <definition>unsigned int gr_simple_correlator::d_center_osi</definition>
        <argsstring></argsstring>
        <name>d_center_osi</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="49" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="49" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a18fdf0b28d78fe63bd578a0fcf315c19" prot="private" static="no" mutable="no">
        <type>unsigned long long int</type>
        <definition>unsigned long long int gr_simple_correlator::d_shift_reg[OVERSAMPLE]</definition>
        <argsstring>[OVERSAMPLE]</argsstring>
        <name>d_shift_reg</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="50" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="50" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1acea1e5683e34ac09277f7bc5292ed610" prot="private" static="no" mutable="no">
        <type>int</type>
        <definition>int gr_simple_correlator::d_bblen</definition>
        <argsstring></argsstring>
        <name>d_bblen</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="51" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="51" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a03f678671306e3b5a578456a8d128151" prot="private" static="no" mutable="no">
        <type>unsigned char *</type>
        <definition>unsigned char* gr_simple_correlator::d_bitbuf</definition>
        <argsstring></argsstring>
        <name>d_bitbuf</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="52" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="52" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a3f654ea3ecbf39b85c2359732d1ef81f" prot="private" static="no" mutable="no">
        <type>int</type>
        <definition>int gr_simple_correlator::d_bbi</definition>
        <argsstring></argsstring>
        <name>d_bbi</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="53" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="53" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a4e96f06be77573ee03622ea1aad2fff6" prot="private" static="no" mutable="no">
        <type>int</type>
        <definition>int gr_simple_correlator::d_avbi</definition>
        <argsstring></argsstring>
        <name>d_avbi</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="56" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="56" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a4a69f41c8adf93d4f1c59bf7584c1854" prot="private" static="no" mutable="no">
        <type>float</type>
        <definition>float gr_simple_correlator::d_avgbuf[AVG_PERIOD]</definition>
        <argsstring>[AVG_PERIOD]</argsstring>
        <name>d_avgbuf</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="57" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="57" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1afec0144dc48daecb85f7fc6252eed4b6" prot="private" static="no" mutable="no">
        <type>float</type>
        <definition>float gr_simple_correlator::d_avg</definition>
        <argsstring></argsstring>
        <name>d_avg</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="58" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="58" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__simple__correlator_1a8b755460a7b1c684cb376e16c7eaf0e7" prot="private" static="no" mutable="no">
        <type>float</type>
        <definition>float gr_simple_correlator::d_accum</definition>
        <argsstring></argsstring>
        <name>d_accum</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="59" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="59" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="friend">
      <memberdef kind="friend" id="classgr__simple__correlator_1a1479b5c7f3c46cd3bb19506efecb871f" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend <ref refid="classboost_1_1shared__ptr" kindref="compound">gr_simple_correlator_sptr</ref></type>
        <definition>gr_simple_correlator_sptr gr_make_simple_correlator</definition>
        <argsstring>(int payload_bytesize)</argsstring>
        <name>gr_make_simple_correlator</name>
        <param>
          <type>int</type>
          <declname>payload_bytesize</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="65"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classgr__simple__correlator_1a6aaf9567f79d64de009a9027d3932d3f" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr_simple_correlator::gr_simple_correlator</definition>
        <argsstring>(int payload_bytesize)</argsstring>
        <name>gr_simple_correlator</name>
        <param>
          <type>int</type>
          <declname>payload_bytesize</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="66"/>
      </memberdef>
      <memberdef kind="function" id="classgr__simple__correlator_1add7d77626ad6acc262e094d572f94177" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int gr_simple_correlator::slice</definition>
        <argsstring>(float x)</argsstring>
        <name>slice</name>
        <param>
          <type>float</type>
          <declname>x</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="70" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="69" bodyend="72"/>
      </memberdef>
      <memberdef kind="function" id="classgr__simple__correlator_1a69197afe53dccd43112e14c20ebaa209" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_simple_correlator::update_avg</definition>
        <argsstring>(float x)</argsstring>
        <name>update_avg</name>
        <param>
          <type>float</type>
          <declname>x</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="74"/>
      </memberdef>
      <memberdef kind="function" id="classgr__simple__correlator_1a3bb9b8af65e1ccc69f2e75977f5becc2" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_simple_correlator::enter_locked</definition>
        <argsstring>()</argsstring>
        <name>enter_locked</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="76"/>
      </memberdef>
      <memberdef kind="function" id="classgr__simple__correlator_1aa2c229606fd84b0cd208eb6fae285e1c" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_simple_correlator::enter_under_threshold</definition>
        <argsstring>()</argsstring>
        <name>enter_under_threshold</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="77"/>
      </memberdef>
      <memberdef kind="function" id="classgr__simple__correlator_1ad342f692c87c797b775458cd4502d365" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_simple_correlator::enter_looking</definition>
        <argsstring>()</argsstring>
        <name>enter_looking</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="78"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-static-func">
      <memberdef kind="function" id="classgr__simple__correlator_1acfe53d10d9393a7258b8465e95566d16" prot="private" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>static int gr_simple_correlator::add_index</definition>
        <argsstring>(int a, int b)</argsstring>
        <name>add_index</name>
        <param>
          <type>int</type>
          <declname>a</declname>
        </param>
        <param>
          <type>int</type>
          <declname>b</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="81" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="80" bodyend="87"/>
      </memberdef>
      <memberdef kind="function" id="classgr__simple__correlator_1a908e5a6c0b4b9d981617edab1b3d8fa8" prot="private" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>static int gr_simple_correlator::sub_index</definition>
        <argsstring>(int a, int b)</argsstring>
        <name>sub_index</name>
        <param>
          <type>int</type>
          <declname>a</declname>
        </param>
        <param>
          <type>int</type>
          <declname>b</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="90" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="89" bodyend="96"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__simple__correlator_1a0c867fa44fc7016d92f9797f81ef6363" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr_simple_correlator::~gr_simple_correlator</definition>
        <argsstring>()</argsstring>
        <name>~gr_simple_correlator</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="100"/>
      </memberdef>
      <memberdef kind="function" id="classgr__simple__correlator_1ae1cdc6cc1f7ea276d7e3cdf025acc367" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>int gr_simple_correlator::general_work</definition>
        <argsstring>(int noutput_items, gr_vector_int &amp;ninput_items, gr_vector_const_void_star &amp;input_items, gr_vector_void_star &amp;output_items)</argsstring>
        <name>general_work</name>
        <reimplements refid="classgr__block_1a137b93d87dc83bbdb6369d33f4ea8197">general_work</reimplements>
        <param>
          <type>int</type>
          <declname>noutput_items</declname>
        </param>
        <param>
          <type><ref refid="classstd_1_1vector" kindref="compound">gr_vector_int</ref> &amp;</type>
          <declname>ninput_items</declname>
        </param>
        <param>
          <type><ref refid="classstd_1_1vector" kindref="compound">gr_vector_const_void_star</ref> &amp;</type>
          <declname>input_items</declname>
        </param>
        <param>
          <type><ref refid="classstd_1_1vector" kindref="compound">gr_vector_void_star</ref> &amp;</type>
          <declname>output_items</declname>
        </param>
        <briefdescription>
<para>compute output items from input items </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>noutput_items</parametername>
</parameternamelist>
<parameterdescription>
<para>number of output items to write on each output stream </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>ninput_items</parametername>
</parameternamelist>
<parameterdescription>
<para>number of input items available on each input stream </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>input_items</parametername>
</parameternamelist>
<parameterdescription>
<para>vector of pointers to the input items, one entry per input stream </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>output_items</parametername>
</parameternamelist>
<parameterdescription>
<para>vector of pointers to the output items, one entry per output stream</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 &lt;= return value &lt;= noutput_items</para></simplesect>
general_work must call consume or consume_each to indicate how many items were consumed on each input stream. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="105"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>inverse of <ref refid="classgr__simple__framer" kindref="compound">gr_simple_framer</ref> (more or less) </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="12758">
        <label>gr_simple_correlator</label>
        <link refid="classgr__simple__correlator"/>
        <childnode refid="12759" relation="public-inheritance">
        </childnode>
      </node>
      <node id="12759">
        <label>gr_block</label>
        <link refid="classgr__block"/>
        <childnode refid="12760" relation="public-inheritance">
        </childnode>
      </node>
      <node id="12760">
        <label>gr_basic_block</label>
        <link refid="classgr__basic__block"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="12777">
        <label>std::vector&lt; gr_buffer_reader * &gt;</label>
        <link refid="classstd_1_1vector"/>
        <childnode refid="12773" relation="usage">
          <edgelabel>p</edgelabel>
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="12772">
        <label>boost::shared_ptr&lt; gr_buffer_reader &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="12773" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="12781">
        <label>T</label>
      </node>
      <node id="12761">
        <label>gr_simple_correlator</label>
        <link refid="classgr__simple__correlator"/>
        <childnode refid="12762" relation="public-inheritance">
        </childnode>
      </node>
      <node id="12773">
        <label>gr_buffer_reader</label>
        <link refid="classgr__buffer__reader"/>
        <childnode refid="12774" relation="usage">
          <edgelabel>d_buffer</edgelabel>
        </childnode>
      </node>
      <node id="12776">
        <label>gr_vmcircbuf</label>
        <link refid="classgr__vmcircbuf"/>
      </node>
      <node id="12762">
        <label>gr_block</label>
        <link refid="classgr__block"/>
        <childnode refid="12763" relation="public-inheritance">
        </childnode>
        <childnode refid="12769" relation="usage">
          <edgelabel>d_detail</edgelabel>
        </childnode>
      </node>
      <node id="12769">
        <label>boost::shared_ptr&lt; gr_block_detail &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="12770" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="12780">
        <label>boost::shared_ptr&lt; T &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="12781" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="12770">
        <label>gr_block_detail</label>
        <link refid="classgr__block__detail"/>
        <childnode refid="12771" relation="usage">
          <edgelabel>d_input</edgelabel>
        </childnode>
        <childnode refid="12778" relation="usage">
          <edgelabel>d_tpb</edgelabel>
        </childnode>
        <childnode refid="12779" relation="usage">
          <edgelabel>d_output</edgelabel>
        </childnode>
      </node>
      <node id="12764">
        <label>boost::shared_ptr&lt; gr_io_signature &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="12765" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="12775">
        <label>gr_buffer</label>
        <link refid="classgr__buffer"/>
        <childnode refid="12776" relation="usage">
          <edgelabel>d_vmcircbuf</edgelabel>
        </childnode>
        <childnode refid="12777" relation="usage">
          <edgelabel>d_readers</edgelabel>
        </childnode>
      </node>
      <node id="12768">
        <label>std::basic_string&lt; char &gt;</label>
      </node>
      <node id="12771">
        <label>std::vector&lt; gr_buffer_reader_sptr &gt;</label>
        <childnode refid="12772" relation="usage">
          <edgelabel>p</edgelabel>
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="12774">
        <label>boost::shared_ptr&lt; gr_buffer &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="12775" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="12778">
        <label>gr_tpb_detail</label>
        <link refid="structgr__tpb__detail"/>
      </node>
      <node id="12779">
        <label>std::vector&lt; gr_buffer_sptr &gt;</label>
        <childnode refid="12780" relation="usage">
          <edgelabel>p</edgelabel>
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="12765">
        <label>gr_io_signature</label>
        <link refid="classgr__io__signature"/>
        <childnode refid="12766" relation="usage">
          <edgelabel>d_sizeof_stream_item</edgelabel>
        </childnode>
      </node>
      <node id="12763">
        <label>gr_basic_block</label>
        <link refid="classgr__basic__block"/>
        <childnode refid="12764" relation="usage">
          <edgelabel>d_input_signature</edgelabel>
          <edgelabel>d_output_signature</edgelabel>
        </childnode>
        <childnode refid="12767" relation="usage">
          <edgelabel>d_name</edgelabel>
        </childnode>
      </node>
      <node id="12766">
        <label>std::vector&lt; int &gt;</label>
        <link refid="classstd_1_1vector"/>
      </node>
      <node id="12767">
        <label>std::string</label>
        <childnode refid="12768" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" line="41" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_simple_correlator.h" bodystart="40" bodyend="106"/>
    <listofallmembers>
      <member refid="classgr__simple__correlator_1acfe53d10d9393a7258b8465e95566d16" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>add_index</name></member>
      <member refid="classgr__simple__correlator_1a6fc8a6ddfcb31c12bd853ed27ea55350" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>AVG_PERIOD</name></member>
      <member refid="classgr__basic__block_1a2503eb6922db0bf2a442dcd2d14670c9" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>basic_block</name></member>
      <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3da0abd1c82699481ffa502e5bb8d7bdaec" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>BLACK</name></member>
      <member refid="classgr__basic__block_1a50a714df9c3ce8c03854a09ac84e589b" prot="public" virt="virtual"><scope>gr_simple_correlator</scope><name>check_topology</name></member>
      <member refid="classgr__basic__block_1a1cedb1704b6c00977c681b378ede384c" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>color</name></member>
      <member refid="classgr__block_1ac76b4c53af762a819bca003d5b5cb4d1" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>consume</name></member>
      <member refid="classgr__block_1a64e9a2096975841b72ff3c1662d27df9" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>consume_each</name></member>
      <member refid="classgr__simple__correlator_1a8b755460a7b1c684cb376e16c7eaf0e7" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_accum</name></member>
      <member refid="classgr__simple__correlator_1a4e96f06be77573ee03622ea1aad2fff6" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_avbi</name></member>
      <member refid="classgr__simple__correlator_1afec0144dc48daecb85f7fc6252eed4b6" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_avg</name></member>
      <member refid="classgr__simple__correlator_1a4a69f41c8adf93d4f1c59bf7584c1854" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_avgbuf</name></member>
      <member refid="classgr__simple__correlator_1a3f654ea3ecbf39b85c2359732d1ef81f" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_bbi</name></member>
      <member refid="classgr__simple__correlator_1acea1e5683e34ac09277f7bc5292ed610" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_bblen</name></member>
      <member refid="classgr__simple__correlator_1a03f678671306e3b5a578456a8d128151" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_bitbuf</name></member>
      <member refid="classgr__simple__correlator_1a382fd1f915f08cf682c58af49935640e" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_center_osi</name></member>
      <member refid="classgr__basic__block_1a7fb7e692e3b98a82410b396ef263bb41" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_color</name></member>
      <member refid="classgr__basic__block_1a2c8da0c28bbbfb0e759278c9b9459e96" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_input_signature</name></member>
      <member refid="classgr__basic__block_1afd352cc073ef28012d4d079a863f5401" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_name</name></member>
      <member refid="classgr__simple__correlator_1a6bfadb7cf32f3ad42151b1e4f26c1b71" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_osi</name></member>
      <member refid="classgr__basic__block_1a76d64ed7a79566e3310306ae6f194d75" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_output_signature</name></member>
      <member refid="classgr__simple__correlator_1a503ab3e3d4b6346bcd2288006770fe37" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_payload_bytesize</name></member>
      <member refid="classgr__simple__correlator_1a18fdf0b28d78fe63bd578a0fcf315c19" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_shift_reg</name></member>
      <member refid="classgr__simple__correlator_1a9ed943eceeb65f69e2f1ef27fdd9c291" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_state</name></member>
      <member refid="classgr__simple__correlator_1a1c92222004eb5d25b5bb87f6c7c7a39c" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_transition_osi</name></member>
      <member refid="classgr__basic__block_1a0d2999c04f47327f93dd7def5dc704f8" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>d_unique_id</name></member>
      <member refid="classgr__block_1afb276858409ac55d62fca1c87d7d4083" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>detail</name></member>
      <member refid="classgr__simple__correlator_1a3bb9b8af65e1ccc69f2e75977f5becc2" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>enter_locked</name></member>
      <member refid="classgr__simple__correlator_1ad342f692c87c797b775458cd4502d365" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>enter_looking</name></member>
      <member refid="classgr__simple__correlator_1aa2c229606fd84b0cd208eb6fae285e1c" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>enter_under_threshold</name></member>
      <member refid="classgr__block_1ab4eeb29440f674815ab3b44b4fb0c34d" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>fixed_rate</name></member>
      <member refid="classgr__block_1a4f17bec4407904b31d45f0d8e78c4683" prot="public" virt="virtual"><scope>gr_simple_correlator</scope><name>fixed_rate_ninput_to_noutput</name></member>
      <member refid="classgr__block_1a196ae6a4f9a3d0abed3428d2b765a133" prot="public" virt="virtual"><scope>gr_simple_correlator</scope><name>fixed_rate_noutput_to_ninput</name></member>
      <member refid="classgr__block_1aa1f2518b5c97126bb015adb9e2027f4a" prot="public" virt="virtual"><scope>gr_simple_correlator</scope><name>forecast</name></member>
      <member refid="classgr__simple__correlator_1ae1cdc6cc1f7ea276d7e3cdf025acc367" prot="public" virt="virtual"><scope>gr_simple_correlator</scope><name>general_work</name></member>
      <member refid="classgr__basic__block_1a1183eee484f58953a2fed4c792e46245" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>gr_basic_block</name></member>
      <member refid="classgr__block_1a268510acce1f94c0a60c5273f4948641" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>gr_block</name></member>
      <member refid="classgr__basic__block_1a69b41e361328cea911d69e1ec0bc50ff" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>gr_flat_flowgraph</name></member>
      <member refid="classgr__basic__block_1adf5bf4523d6dd698aa770e3da8f2b30d" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>gr_flowgraph</name></member>
      <member refid="classgr__simple__correlator_1a1479b5c7f3c46cd3bb19506efecb871f" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>gr_make_simple_correlator</name></member>
      <member refid="classgr__simple__correlator_1a6aaf9567f79d64de009a9027d3932d3f" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>gr_simple_correlator</name></member>
      <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3daa6cce7ec34a3f9cf917e545a743dc89f" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>GREY</name></member>
      <member refid="classgr__block_1ad3b305a663f4b5b5c4e17070d00f05d9" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>history</name></member>
      <member refid="classgr__basic__block_1a58f6d05e85931200f3771d3e50741281" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>input_signature</name></member>
      <member refid="classgr__basic__block_1aa12a20d8b8eab341da935530d29299d2" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>name</name></member>
      <member refid="classgr__block_1ade8590e9cba9ccfe1b870be46b1416c2" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>output_multiple</name></member>
      <member refid="classgr__basic__block_1add68b96f012dfe352700b4fd1c3a184a" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>output_signature</name></member>
      <member refid="classgr__simple__correlator_1a1ed450ed9035055006d0f76ecac2000b" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>OVERSAMPLE</name></member>
      <member refid="classgr__block_1aa9df8c4d3fb92bde98900831546f8b97" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>relative_rate</name></member>
      <member refid="classgr__basic__block_1a0821ef947158670d53bf0739f3c8877b" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>set_color</name></member>
      <member refid="classgr__block_1a26b61f2c2ca308c3bde82f01d3e9650b" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>set_detail</name></member>
      <member refid="classgr__block_1a176a95343488a9a760c8edf8bb08db20" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>set_fixed_rate</name></member>
      <member refid="classgr__block_1a7c1c85a2d47f72255efd821a6f98f7ba" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>set_history</name></member>
      <member refid="classgr__basic__block_1a419d0fbba0ca02d822cbc299b979de54" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>set_input_signature</name></member>
      <member refid="classgr__block_1a14e8b799f920e52afb93fac413b1a729" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>set_output_multiple</name></member>
      <member refid="classgr__basic__block_1a949b6ad69ebfdf423835265db99cf63d" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>set_output_signature</name></member>
      <member refid="classgr__block_1ab9dc7e6d30692bbfa65fc7c4eef6fc9d" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>set_relative_rate</name></member>
      <member refid="classgr__simple__correlator_1add7d77626ad6acc262e094d572f94177" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>slice</name></member>
      <member refid="classgr__simple__correlator_1ac429619a738ab152923e3e227742429ea8ebd4faa6f37ea94818796daf110d191" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>ST_LOCKED</name></member>
      <member refid="classgr__simple__correlator_1ac429619a738ab152923e3e227742429ea5f2d9fc1082bea53f899fa375ba8343e" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>ST_LOOKING</name></member>
      <member refid="classgr__simple__correlator_1ac429619a738ab152923e3e227742429ea3a2df3f371ccfbf5b4c82819a40ae385" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>ST_UNDER_THRESHOLD</name></member>
      <member refid="classgr__block_1a49ea94a86f3199f23563bb837633ea1f" prot="public" virt="virtual"><scope>gr_simple_correlator</scope><name>start</name></member>
      <member refid="classgr__simple__correlator_1ac429619a738ab152923e3e227742429e" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>state_t</name></member>
      <member refid="classgr__block_1a53c2c89c037e4e393b75414d605e36b1" prot="public" virt="virtual"><scope>gr_simple_correlator</scope><name>stop</name></member>
      <member refid="classgr__simple__correlator_1a908e5a6c0b4b9d981617edab1b3d8fa8" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>sub_index</name></member>
      <member refid="classgr__basic__block_1aa2a2947744d418c5470fbf4e623b58fe" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>unique_id</name></member>
      <member refid="classgr__simple__correlator_1a69197afe53dccd43112e14c20ebaa209" prot="private" virt="non-virtual"><scope>gr_simple_correlator</scope><name>update_avg</name></member>
      <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3d" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>vcolor</name></member>
      <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3da476d594a077e729bad0f2cfa2008c899" prot="protected" virt="non-virtual"><scope>gr_simple_correlator</scope><name>WHITE</name></member>
      <member refid="classgr__basic__block_1a5bc14d27d53b7b57a960a47cc255e3f9" prot="public" virt="virtual"><scope>gr_simple_correlator</scope><name>~gr_basic_block</name></member>
      <member refid="classgr__block_1a19133eeffa5f8e6743342f375551ad0c" prot="public" virt="virtual"><scope>gr_simple_correlator</scope><name>~gr_block</name></member>
      <member refid="classgr__simple__correlator_1a0c867fa44fc7016d92f9797f81ef6363" prot="public" virt="non-virtual"><scope>gr_simple_correlator</scope><name>~gr_simple_correlator</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>