Sophie

Sophie

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

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="classgri__agc__ff" kind="class" prot="public">
    <compoundname>gri_agc_ff</compoundname>
    <derivedcompoundref refid="classgr__agc__ff" prot="public" virt="non-virtual">gr_agc_ff</derivedcompoundref>
    <includes refid="gri__agc__ff_8h" local="no">gri_agc_ff.h</includes>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classgri__agc__ff_1ab66e127802a267002c1fa2bbe52e2b29" prot="protected" static="no" mutable="no">
        <type>float</type>
        <definition>float gri_agc_ff::_rate</definition>
        <argsstring></argsstring>
        <name>_rate</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="64" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="64" bodyend="-1"/>
        <referencedby refid="classgri__agc__ff_1acec6a2a2778e4fd8746d521d88c16df9" compoundref="gri__agc__ff_8h" startline="40" endline="40">rate</referencedby>
        <referencedby refid="classgri__agc__ff_1a6f5ef887c62144816b05327614c3b74a" compoundref="gri__agc__ff_8h" startline="50" endline="56">scale</referencedby>
        <referencedby refid="classgri__agc__ff_1a0faa33eebad5116c8bb55770afe24425" compoundref="gri__agc__ff_8h" startline="45" endline="45">set_rate</referencedby>
      </memberdef>
      <memberdef kind="variable" id="classgri__agc__ff_1a6f644c07e2eb5da83ef7463b7254a84c" prot="protected" static="no" mutable="no">
        <type>float</type>
        <definition>float gri_agc_ff::_reference</definition>
        <argsstring></argsstring>
        <name>_reference</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="65" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="65" bodyend="-1"/>
        <referencedby refid="classgri__agc__ff_1a3c86925a6be8e686ab22fc3fc5433f73" compoundref="gri__agc__ff_8h" startline="41" endline="41">reference</referencedby>
        <referencedby refid="classgri__agc__ff_1a6f5ef887c62144816b05327614c3b74a" compoundref="gri__agc__ff_8h" startline="50" endline="56">scale</referencedby>
        <referencedby refid="classgri__agc__ff_1a486601c1d862e7dd2d5f646dad7aa026" compoundref="gri__agc__ff_8h" startline="46" endline="46">set_reference</referencedby>
      </memberdef>
      <memberdef kind="variable" id="classgri__agc__ff_1a6c4339e60e22eabeed2f2bc8fb049502" prot="protected" static="no" mutable="no">
        <type>float</type>
        <definition>float gri_agc_ff::_gain</definition>
        <argsstring></argsstring>
        <name>_gain</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="66" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="66" bodyend="-1"/>
        <referencedby refid="classgri__agc__ff_1a8823aade27e387b5b44b45d13faefcb4" compoundref="gri__agc__ff_8h" startline="42" endline="42">gain</referencedby>
        <referencedby refid="classgri__agc__ff_1a6f5ef887c62144816b05327614c3b74a" compoundref="gri__agc__ff_8h" startline="50" endline="56">scale</referencedby>
        <referencedby refid="classgri__agc__ff_1a7f8d27e626282427bf163728c805ef40" compoundref="gri__agc__ff_8h" startline="47" endline="47">set_gain</referencedby>
      </memberdef>
      <memberdef kind="variable" id="classgri__agc__ff_1a727b4f656c8a37f92a94269b20103658" prot="protected" static="no" mutable="no">
        <type>float</type>
        <definition>float gri_agc_ff::_max_gain</definition>
        <argsstring></argsstring>
        <name>_max_gain</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="67" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="67" bodyend="-1"/>
        <referencedby refid="classgri__agc__ff_1af718da2149e650d8c47ba88bac6965c8" compoundref="gri__agc__ff_8h" startline="43" endline="43">max_gain</referencedby>
        <referencedby refid="classgri__agc__ff_1a6f5ef887c62144816b05327614c3b74a" compoundref="gri__agc__ff_8h" startline="50" endline="56">scale</referencedby>
        <referencedby refid="classgri__agc__ff_1ae38654d026cf2e4634febc8acaa84c03" compoundref="gri__agc__ff_8h" startline="48" endline="48">set_max_gain</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgri__agc__ff_1a6a37d93547bce6f637fe741e5a68a55b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>gri_agc_ff::gri_agc_ff</definition>
        <argsstring>(float rate=1e-4, float reference=1.0, float gain=1.0, float max_gain=0.0)</argsstring>
        <name>gri_agc_ff</name>
        <param>
          <type>float</type>
          <declname>rate</declname>
          <defval>1e-4</defval>
        </param>
        <param>
          <type>float</type>
          <declname>reference</declname>
          <defval>1.0</defval>
        </param>
        <param>
          <type>float</type>
          <declname>gain</declname>
          <defval>1.0</defval>
        </param>
        <param>
          <type>float</type>
          <declname>max_gain</declname>
          <defval>0.0</defval>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="38" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="36" bodyend="38"/>
      </memberdef>
      <memberdef kind="function" id="classgri__agc__ff_1acec6a2a2778e4fd8746d521d88c16df9" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>float</type>
        <definition>float gri_agc_ff::rate</definition>
        <argsstring>() const </argsstring>
        <name>rate</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="40" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="40" bodyend="40"/>
        <references refid="classgri__agc__ff_1ab66e127802a267002c1fa2bbe52e2b29" compoundref="gri__agc__ff_8h" startline="64">_rate</references>
        <referencedby refid="classgri__agc__ff_1a0faa33eebad5116c8bb55770afe24425" compoundref="gri__agc__ff_8h" startline="45" endline="45">set_rate</referencedby>
      </memberdef>
      <memberdef kind="function" id="classgri__agc__ff_1a3c86925a6be8e686ab22fc3fc5433f73" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>float</type>
        <definition>float gri_agc_ff::reference</definition>
        <argsstring>() const </argsstring>
        <name>reference</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="41" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="41" bodyend="41"/>
        <references refid="classgri__agc__ff_1a6f644c07e2eb5da83ef7463b7254a84c" compoundref="gri__agc__ff_8h" startline="65">_reference</references>
        <referencedby refid="classgri__agc__ff_1a486601c1d862e7dd2d5f646dad7aa026" compoundref="gri__agc__ff_8h" startline="46" endline="46">set_reference</referencedby>
      </memberdef>
      <memberdef kind="function" id="classgri__agc__ff_1a8823aade27e387b5b44b45d13faefcb4" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>float</type>
        <definition>float gri_agc_ff::gain</definition>
        <argsstring>() const </argsstring>
        <name>gain</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="42" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="42" bodyend="42"/>
        <references refid="classgri__agc__ff_1a6c4339e60e22eabeed2f2bc8fb049502" compoundref="gri__agc__ff_8h" startline="66">_gain</references>
        <referencedby refid="classgri__agc__ff_1a7f8d27e626282427bf163728c805ef40" compoundref="gri__agc__ff_8h" startline="47" endline="47">set_gain</referencedby>
      </memberdef>
      <memberdef kind="function" id="classgri__agc__ff_1af718da2149e650d8c47ba88bac6965c8" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>float</type>
        <definition>float gri_agc_ff::max_gain</definition>
        <argsstring>() const </argsstring>
        <name>max_gain</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="43" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="43" bodyend="43"/>
        <references refid="classgri__agc__ff_1a727b4f656c8a37f92a94269b20103658" compoundref="gri__agc__ff_8h" startline="67">_max_gain</references>
        <referencedby refid="classgri__agc__ff_1ae38654d026cf2e4634febc8acaa84c03" compoundref="gri__agc__ff_8h" startline="48" endline="48">set_max_gain</referencedby>
      </memberdef>
      <memberdef kind="function" id="classgri__agc__ff_1a0faa33eebad5116c8bb55770afe24425" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void gri_agc_ff::set_rate</definition>
        <argsstring>(float rate)</argsstring>
        <name>set_rate</name>
        <param>
          <type>float</type>
          <declname>rate</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="45" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="45" bodyend="45"/>
        <references refid="classgri__agc__ff_1ab66e127802a267002c1fa2bbe52e2b29" compoundref="gri__agc__ff_8h" startline="64">_rate</references>
        <references refid="classgri__agc__ff_1acec6a2a2778e4fd8746d521d88c16df9" compoundref="gri__agc__ff_8h" startline="40" endline="40">rate</references>
      </memberdef>
      <memberdef kind="function" id="classgri__agc__ff_1a486601c1d862e7dd2d5f646dad7aa026" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void gri_agc_ff::set_reference</definition>
        <argsstring>(float reference)</argsstring>
        <name>set_reference</name>
        <param>
          <type>float</type>
          <declname>reference</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="46" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="46" bodyend="46"/>
        <references refid="classgri__agc__ff_1a6f644c07e2eb5da83ef7463b7254a84c" compoundref="gri__agc__ff_8h" startline="65">_reference</references>
        <references refid="classgri__agc__ff_1a3c86925a6be8e686ab22fc3fc5433f73" compoundref="gri__agc__ff_8h" startline="41" endline="41">reference</references>
      </memberdef>
      <memberdef kind="function" id="classgri__agc__ff_1a7f8d27e626282427bf163728c805ef40" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void gri_agc_ff::set_gain</definition>
        <argsstring>(float gain)</argsstring>
        <name>set_gain</name>
        <param>
          <type>float</type>
          <declname>gain</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="47" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="47" bodyend="47"/>
        <references refid="classgri__agc__ff_1a6c4339e60e22eabeed2f2bc8fb049502" compoundref="gri__agc__ff_8h" startline="66">_gain</references>
        <references refid="classgri__agc__ff_1a8823aade27e387b5b44b45d13faefcb4" compoundref="gri__agc__ff_8h" startline="42" endline="42">gain</references>
      </memberdef>
      <memberdef kind="function" id="classgri__agc__ff_1ae38654d026cf2e4634febc8acaa84c03" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void gri_agc_ff::set_max_gain</definition>
        <argsstring>(float max_gain)</argsstring>
        <name>set_max_gain</name>
        <param>
          <type>float</type>
          <declname>max_gain</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="48" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="48" bodyend="48"/>
        <references refid="classgri__agc__ff_1a727b4f656c8a37f92a94269b20103658" compoundref="gri__agc__ff_8h" startline="67">_max_gain</references>
        <references refid="classgri__agc__ff_1af718da2149e650d8c47ba88bac6965c8" compoundref="gri__agc__ff_8h" startline="43" endline="43">max_gain</references>
      </memberdef>
      <memberdef kind="function" id="classgri__agc__ff_1a6f5ef887c62144816b05327614c3b74a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>float</type>
        <definition>float gri_agc_ff::scale</definition>
        <argsstring>(float input)</argsstring>
        <name>scale</name>
        <param>
          <type>float</type>
          <declname>input</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="50" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="50" bodyend="56"/>
        <references refid="classgri__agc__ff_1a6c4339e60e22eabeed2f2bc8fb049502" compoundref="gri__agc__ff_8h" startline="66">_gain</references>
        <references refid="classgri__agc__ff_1a727b4f656c8a37f92a94269b20103658" compoundref="gri__agc__ff_8h" startline="67">_max_gain</references>
        <references refid="classgri__agc__ff_1ab66e127802a267002c1fa2bbe52e2b29" compoundref="gri__agc__ff_8h" startline="64">_rate</references>
        <references refid="classgri__agc__ff_1a6f644c07e2eb5da83ef7463b7254a84c" compoundref="gri__agc__ff_8h" startline="65">_reference</references>
        <referencedby refid="classgri__agc__ff_1a516257ff14a1d70b230773c0fdb7d77b" compoundref="gri__agc__ff_8h" startline="58" endline="61">scaleN</referencedby>
      </memberdef>
      <memberdef kind="function" id="classgri__agc__ff_1a516257ff14a1d70b230773c0fdb7d77b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void gri_agc_ff::scaleN</definition>
        <argsstring>(float output[], const float input[], unsigned n)</argsstring>
        <name>scaleN</name>
        <param>
          <type>float</type>
          <declname>output</declname>
          <array>[]</array>
        </param>
        <param>
          <type>const float</type>
          <declname>input</declname>
          <array>[]</array>
        </param>
        <param>
          <type>unsigned</type>
          <declname>n</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="58" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="58" bodyend="61"/>
        <references refid="classgri__agc__ff_1a6f5ef887c62144816b05327614c3b74a" compoundref="gri__agc__ff_8h" startline="50" endline="56">scale</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>high performance Automatic Gain Control class </para>    </briefdescription>
    <detaileddescription>
<para>Power is approximated by absolute value </para>    </detaileddescription>
    <inheritancegraph>
      <node id="14626">
        <label>gr_agc_ff</label>
        <link refid="classgr__agc__ff"/>
        <childnode refid="14625" relation="public-inheritance">
        </childnode>
      </node>
      <node id="14625">
        <label>gri_agc_ff</label>
        <link refid="classgri__agc__ff"/>
      </node>
    </inheritancegraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" line="33" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gri_agc_ff.h" bodystart="33" bodyend="68"/>
    <listofallmembers>
      <member refid="classgri__agc__ff_1a6c4339e60e22eabeed2f2bc8fb049502" prot="protected" virt="non-virtual"><scope>gri_agc_ff</scope><name>_gain</name></member>
      <member refid="classgri__agc__ff_1a727b4f656c8a37f92a94269b20103658" prot="protected" virt="non-virtual"><scope>gri_agc_ff</scope><name>_max_gain</name></member>
      <member refid="classgri__agc__ff_1ab66e127802a267002c1fa2bbe52e2b29" prot="protected" virt="non-virtual"><scope>gri_agc_ff</scope><name>_rate</name></member>
      <member refid="classgri__agc__ff_1a6f644c07e2eb5da83ef7463b7254a84c" prot="protected" virt="non-virtual"><scope>gri_agc_ff</scope><name>_reference</name></member>
      <member refid="classgri__agc__ff_1a8823aade27e387b5b44b45d13faefcb4" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>gain</name></member>
      <member refid="classgri__agc__ff_1a6a37d93547bce6f637fe741e5a68a55b" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>gri_agc_ff</name></member>
      <member refid="classgri__agc__ff_1af718da2149e650d8c47ba88bac6965c8" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>max_gain</name></member>
      <member refid="classgri__agc__ff_1acec6a2a2778e4fd8746d521d88c16df9" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>rate</name></member>
      <member refid="classgri__agc__ff_1a3c86925a6be8e686ab22fc3fc5433f73" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>reference</name></member>
      <member refid="classgri__agc__ff_1a6f5ef887c62144816b05327614c3b74a" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>scale</name></member>
      <member refid="classgri__agc__ff_1a516257ff14a1d70b230773c0fdb7d77b" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>scaleN</name></member>
      <member refid="classgri__agc__ff_1a7f8d27e626282427bf163728c805ef40" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>set_gain</name></member>
      <member refid="classgri__agc__ff_1ae38654d026cf2e4634febc8acaa84c03" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>set_max_gain</name></member>
      <member refid="classgri__agc__ff_1a0faa33eebad5116c8bb55770afe24425" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>set_rate</name></member>
      <member refid="classgri__agc__ff_1a486601c1d862e7dd2d5f646dad7aa026" prot="public" virt="non-virtual"><scope>gri_agc_ff</scope><name>set_reference</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>